Integrate identity verification across Africa with our simple, powerful REST API
id_document
Verify government-issued identity documents such as passports, national IDs, and driver's licenses across 47+ African countries.
https://api.verifyafrica.io/api/verifications/requests/Include your API key in the X-API-KEY header:
X-API-KEY: your_api_key_hereGenerates a hosted verification URL to send to the customer. The customer completes verification on the hosted page.
Customer's email address. Used to send the hosted verification link.
ISO 3166-1 alpha-2 country code (e.g., "NG", "ZA", "GH", "KE").
Language for the hosted verification page (e.g., "EN", "FR"). Defaults to "EN".
Link expiry time in minutes. Allowed: 30, 60, 180, 360, 720, 1440, 2880. Defaults to 60.
eKYC fallback configuration for link mode.
Set to "0" to disable fallback. Defaults to "0".
curl -X POST https://api.verifyafrica.io/api/verifications/requests/ \
-H "X-API-KEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"is_test": false,
"verification_type": "id_document",
"method_type": "onsite",
"input_data": {
"country": "NG",
"language": "EN",
"email": "customer@example.com",
"ttl": 60,
"ekyc": {
"allow_fallback": "0"
}
}
}'{
"status": "success",
"data": {
"id": "ver_abc123",
"verification_type": "id_document",
"status": "completed",
"created_at": "2025-01-15T10:30:00Z",
"verification_url": "https://verify.shufti.com/verification/abc123"
}
}| Code | Description |
|---|---|
200 | Success - Verification completed |
400 | Bad Request - Missing or invalid parameters |
401 | Unauthorized - Invalid or missing API key |
403 | Forbidden - Insufficient credits or inactive key |
404 | Not Found - Identity record not found |
500 | Internal Server Error - Please try again |
Need help? Contact us at dev@verifyafrica.io
We use cookies to improve your experience, analyse site traffic, and personalise content. By clicking "Accept All" you consent to our use of cookies. You can choose "Reject Non-Essential" to only allow strictly necessary cookies. Cookie Policy