Verification API

1. Endpoint

POST https://your-portal-domain/api/public/v1/verify

2. Authentication

Send your key in the X-API-Key header. Keep it on your server — never put it in a website or mobile app.

X-API-Key: vp_your_key_here
Content-Type: application/json

3. Check one number

curl -X POST https://your-portal-domain/api/public/v1/verify \
  -H "X-API-Key: vp_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"number":"0541234567"}'

{ "number": "0541234567", "status": "verified" }

4. Check up to 100 numbers

{ "numbers": ["0541234567", "233551234567", "0201234567"] }

{
  "results": [
    { "number": "0541234567", "status": "verified" },
    { "number": "0551234567", "status": "not_verified" },
    { "number": "0201234567", "status": "try_again" }
  ],
  "summary": {
    "total": 3,
    "verified": 1,
    "not_verified": 1,
    "try_again": 1,
    "invalid_number": 0
  }
}

Numbers can be in 054… or 233… format.

5. Status values

• verified — the number is verified.
• not_verified — the number is not verified.
• try_again — couldn't be confirmed right now; retry in a minute. Never treat this as not verified.
• invalid_number — not a valid Ghana number.

6. Limits & errors

• 60 requests per minute per key; up to 100 numbers per request.
• 400 bad request · 401 missing or invalid key · 429 limit reached, wait and retry · 503 temporarily unavailable.