Verify A Generic ID Card

Developing

POST

/api/v1/public/documentverification/id-card

Reads any other identity card image and checks that the ID number and name you supplied match what appears on it. Use this for card types with no dedicated endpoint. Extraction is AI-assisted while the match score is computed locally, so identical inputs always score identically. Results are cached for 24 hours by document type and payload. The wallet is debited on every call including cache hits, at your configured document verification fee less a 30% discount when your company supplies its own OpenAI or Azure OpenAI key. Note this endpoint returns the responseCode/responseMessage/responseData envelope, not the status/message/data one.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Verification completed. Check responseData.valid for the verdict — a 200 does not mean the document passed.

Bodyapplication/json

🟠400

🟠401

🔴502

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/public/documentverification/id-card' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "idNumber": "EMP-004512",
    "fullName": "Adaeze Okonkwo",
    "imageUrl": "https://cdn.example.com/docs/id-card.jpg"
}'

Response Example

200 - Example 1

{
    "responseCode": "00",
    "responseMessage": "Document verification completed.",
    "responseData": {
        "valid": true,
        "confidenceScore": 96.4,
        "reason": "Name and ID number match the document."
    }
}

Modified at 2026-08-06 11:58:31

Verify A Driver's Licence

Verify A MemArt Or Form CO2