VerifyAfrica – KYC, AML & Identity Verification Across Africa

Explore Dashboard

API Documentation

Integrate identity verification across Africa with our simple, powerful REST API

API Sections

API Reference

Document Verification

id_document

Verify government-issued identity documents such as passports, national IDs, and driver's licenses across 47+ African countries.

Endpoint

POSThttps://api.verifyafrica.io/api/verifications/requests/

Authentication Required

Include your API key in the X-API-KEY header:

X-API-KEY: your_api_key_here

Verification Mode

Generates a hosted verification URL to send to the customer. The customer completes verification on the hosted page.

Request Parameters (input_data)

emailstringrequired

Customer's email address. Used to send the hosted verification link.

countrystringoptional

ISO 3166-1 alpha-2 country code (e.g., "NG", "ZA", "GH", "KE").

languagestringoptional

Language for the hosted verification page (e.g., "EN", "FR"). Defaults to "EN".

ttlnumberoptional

Link expiry time in minutes. Allowed: 30, 60, 180, 360, 720, 1440, 2880. Defaults to 60.

ekycobjectoptional

eKYC fallback configuration for link mode.

allow_fallbackstringoptional

Set to "0" to disable fallback. Defaults to "0".

Sample Request

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"
    }
  }
}'

Expected Response Structure

{
  "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"
  }
}

Response Codes

CodeDescription
200Success - Verification completed
400Bad Request - Missing or invalid parameters
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient credits or inactive key
404Not Found - Identity record not found
500Internal Server Error - Please try again

Need help? Contact us at dev@verifyafrica.io