Identity verification
This endpoint allows you to verify identities for BVN, NIN, Passport, Drivers License and PVC.
POST
{{baseurl}}/v1/identities/candidates/check
Header
token
String
API secret token
Parameter
report_typeoptional
String
Report type
Default value: identity
reference
String
Identity number. One of BVN, NIN, Passport, Drivers License and PVC
type
String
Must be one of ibvn,
passport, inec, frsc, nin, nin_facial, bvn_facial or passport_facial
subject_consent
Boolean
Indicate subject has given consent. Must be true
last_name
String
last name of subject. required for passport and passport_facial
and optional for other IDs
first_nameoptional
String
firstname of subject
middle_nameoptional
String
middlename of subject
doboptional
String
date of birth
image
String
Base64 or Image URL to compare ID image with. Required for type of bvn_facial, nin_facial and passport_facial
{
"report_type": "identity",
"type": "ibvn",
"reference": "20202xxxxxx",
"first_name": "Famous",
"middle_name": "",
"last_name": "Ehichioya",
"dob": "1988-04-04",
"subject_consent": true
}
Sample Responses for each verification
HTTP/1.1 200 OK
{
"message": "Successful",
"data": {
"id": "61f5e0f6d656e7d19b78779a",
"type": "ibvn",
"task_created_by": "Youcheck Online Services Limited",
"reference_id": "223286xxxxxx",
"status": "found",
"response": {
"first_name": "FAMOUS",
"middle_name": "PRIOR",
"mobile": "08036xxxxxx",
"last_name": "EHICHIOYA",
"dob": "1988-04-04",
"photo": "data:image/jpg;base64,/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8U",
"subject_consent": true,
"reference_id": "223286xxxxxx",
}
},
"status_code": 200
}
HTTP/1.1 404 Not Found
{
"message": "No Result was found",
"name": "LegacyAPIError",
"status_code": 404
}
Last updated
Was this helpful?