Verify Document
This endpoint allows you to verify the validity of a document.
Endpoint: POST {baseurl}/v1/api/verification/document
Request Body
Parameter | Type | Required | Description |
---|---|---|---|
country |
string |
Yes | The country code (e.g., "NGA" for Nigeria, "KEN" for Kenya, "GHA" for Ghana). Currently supports the following countries: Kenya, Nigeria, Ghana. |
reference |
string |
Yes | A unique reference ID for the verification request. |
identity |
string |
Yes | A unique identifier for the user. |
verificationLevel |
string |
Yes | The level of verification to perform (e.g., "basic", "Extended"). |
documentType |
string |
Yes | The type of document to verify (values are: National ID = ng_national_id , Drivers License = ng_drivers_license , international passport = ng_international_passport , Voters Card = ng_voters_card ). |
documentImage |
string |
Yes | A base64-encoded string of the document image. |
Sample Request
curl -X 'POST' \
'https://api.sourceid.tech/v1/api/verification/document' \
-H 'accept: application/json' \
-H 'x-api-key: sk_live_v1_2GndGZyB298zcU802hgze1ltu8nCEd' \
-H 'Content-Type: application/json' \
-d '{
"country": "NGA",
"reference": "0122333412344455555",
"identity": "67f6050e03418e0428005cea",
"verificationLevel": "basic",
"documentType": "ng_national_id",
"documentImage": "base64_encoded_image_string"
}'
Sample Response
{
"status": true,
"responseCode": "00",
"statusCode": "200",
"message": "Document verification successful",
"data": {
"fullName": " ",
"documentNumber": " ",
"expirationDate": null
},
"meta": {
"statusCode": "200",
"isValid": true,
"timeStamp": "Wed Apr 23 2025 06:24:24 GMT+0000 (Coordinated Universal Time)"
}
}