Number verification
Submit Ghana MSISDNs for async verification, then poll until the batch reaches a terminal status. Provider vendors are never exposed in responses.
How to use
- Ensure the API key includes scope
numbers:verify(Developers → application → Credentials). Missing scope →FORBIDDEN. POST /numbers/verificationswith one or more MSISDNs.- Poll
GET /numbers/verifications/{id}or/statusuntil the batch is terminal.
Create verification
POST
https://confident-elephant-309.convex.site/v1/numbers/verificationsRequest
curl -sS https://confident-elephant-309.convex.site/v1/numbers/verifications \ -H "Authorization: Bearer $KEY" \ -H "Content-Type: application/json" \ -d '{ "numbers": ["0241234567", { "phone": "0201234567", "contactName": "Ama" }], "externalReference": "batch-42" }'202 Accepted
{ "verification": { "id": "NV-ABC123", "reference": "NV-ABC123", "status": "processing", "numberCount": 2, "counts": { "total": 2, "pending": 2, "processing": 0, "verified": 0, "failed": 0, "rejected": 0 }, "items": [ { "msisdn": "0241234567", "network": "mtn", "status": "pending", "note": null, "contactName": null, "verifiedAt": null } ] }, "invalid": [], "duplicates": []}Get / status
GET
https://confident-elephant-309.convex.site/v1/numbers/verifications/{id}Request
curl -sS https://confident-elephant-309.convex.site/v1/numbers/verifications/$ID \ -H "Authorization: Bearer $KEY"Compact status: GET /numbers/verifications/{id}/status. Use the NV-… reference from create (id / reference).
Statuses
| Request status | Meaning |
|---|---|
| pending / processing | Still running |
| completed | All items verified |
| partially_verified | Mix of verified and failed/rejected |
| failed | No successes |