Identity verification
This endpoint allows you to verify identities for BVN, NIN, Passport, Drivers License and PVC.
POST
{{baseurl}}/v1/identities/candidates/check
Header
Parameter
{
"report_type": "identity",
"type": "ibvn",
"reference": "20202xxxxxx",
"first_name": "Famous",
"middle_name": "",
"last_name": "Ehichioya",
"dob": "1988-04-04",
"subject_consent": true
}
{
"report_type": "identity",
"type": "frsc",
"reference": "SMK862xxxxxx",
"first_name": "Famous",
"middle_name": "",
"last_name": "Ehichioya",
"dob": "1998-04-04"
}
{
"report_type": "identity",
"type": "passport",
"reference": "A07xxxxxx",
"first_name": "Famous",
"middle_name": "",
"last_name": "Ehichioya",
"dob": "1988-04-04"
}
{
"report_type": "identity",
"type": "inec",
"reference": "90F5AFA35D2xxxxxxxx",
"first_name": "Famous",
"middle_name": "",
"last_name": "Ehichioya",
"dob": "1988-04-04"
}
{
"report_type": "identity",
"type": "nin",
"reference": "90645xxxxxx",
"first_name": "Famous",
"middle_name": "",
"last_name": "Ehichioya",
"dob": "1988-04-04"
}
{
"report_type": "identity",
"type": "passport_facial",
"reference": "A11xxxxxx",
"last_name": "Ehichioya",
"image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAkACQAAD/4Q",
"subject_consent": true
}
{
"report_type": "identity",
"type": "bvn_facial",
"reference": "21234xxxxxx",
"image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAkACQAAD/4Q",
"subject_consent": true
}
{
"report_type": "identity",
"type": "nin_facial",
"reference": "602134xxxxx",
"image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAkACQAAD/4Q",
"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 200 OK
{
"message": "Successful",
"data": {
"id": "61f6d647911ad409d27f2b62",
"type": "nin",
"task_created_by": "Youcheck Online Services Limited",
"reference_id": "90899xxxxxx",
"status": "found",
"response": {
"first_name": "FAMOUS",
"last_name": "EHICHIOYA",
"middle_name": "PRIOR",
"dob": "1988-04-04",
"mobile": "08036xxxxxx",
"reference_id": "90899xxxxxx",
"batch_id": null,
"birth_country": "nigeria",
"birth_lga": "Suleja",
"birth_state": "Niger",
"card_status": null,
"central_id": null,
"document_no": null,
"educational_level": null,
"employment_status": null,
"gender": "male",
"height": null,
"maiden_name": null,
"marital_status": null,
"nok_address1": "****",
"nok_address2": "",
"nok_firstname": "****",
"nok_lga": "****",
"nok_state": "****",
"nok_surname": "****",
"nok_town": "****",
"ospokenlang": "****",
"photo": "data:image/jpg;base64,/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQN",
"religion": "christianity",
"residence_address_line1": "OPPOSITE SULEIMAN BARAU TECHNICAL COLLEGE KWAMBA.",
"residence_town": null,
"residence_lga": "SULEJA",
"residence_state": "Niger",
"self_origin_lga": "Suleja",
"self_origin_place": "****",
"self_origin_state": "Niger",
"signature": "data:image/jpg;base64,/9j/4AAQSkZJRgABAQEAlgCWAAD/2wBDAAgGBgcGBQgHBwc",
"tracking_id": null
}
},
"status_code": 200
}
HTTP/1.1 200 OK
{
"message": "Successful",
"data": {
"id": "61f6d5bc2257380884db81ba",
"type": "inec",
"task_created_by": "Youcheck Online Services Limited",
"reference_id": "90F5AFA35D2xxxxxxxx",
"status": "found",
"response": {
"first_name": "FAMOUS",
"last_name": "EHICHIOYA",
"middle_name": "PRIOR",
"dob": "1968-07-24",
"mobile": null,
"reference_id": "90F5AFA35D2xxxxxxxx"
}
},
"status_code": 200
}
HTTP/1.1 200 OK
{
"message": "Successful",
"data": {
"id": "61f6d72e6475780b91eda6c0",
"type": "passport",
"task_created_by": "Youcheck Online Services Limited",
"reference_id": "A07xxxxxx",
"status": "found",
"response": {
"first_name": "FAMOUS",
"last_name": "Ehichioya",
"middle_name": "PRIOR",
"dob": "1966-02-04",
"mobile": null,
"photo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAFACAYAAACC6PFTA",
"gender": "male",
"issued_at": "MINNA",
"issued_date": "2016-02-23T00:00:00.000Z",
"expiry_date": "2021-02-22T00:00:00.000Z",
"reference_id": "A07xxxxxx"
}
},
"status_code": 200
}
HTTP/1.1 200 OK
{
"message": "Successful",
"data": {
"id": "61f69b1957d422f1152bb745",
"type": "frsc",
"status": "found",
"task_created_by": "Youcheck Online Services Limited",
"reference_id": "SMK862xxxxxx",
"response": {
"residence_address_line1": null,
"residence_town": null,
"residence_lga": null,
"residence_state": null,
"application_first_issued_date": null,
"application_issued_date": "2021-05-26T00:00:00.000Z",
"application_expiry_date": "2026-04-04T00:00:00.000Z",
"state_of_issuance": "LAGOS",
"dob": "1968-04-04",
"photo": "data:image/jpg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQ...",
"disability": null,
"facial_mark": null,
"first_state_of_issuance": null,
"first_name": "FAMOUS",
"gender": "male",
"glasses": null,
"height": null,
"self_origin_lga": null,
"license": {
"class": null,
"description": null
},
"mobile": null,
"maiden_name": null,
"birth_country": null,
"next_of_kin_phone_number": null,
"middle_name": null,
"previous_dl_number": null,
"birth_state": null,
"last_name": "EHICHIOYA",
"subject_consent": true,
"reference_id": "SMK862xxxxxx",
}
},
"status_code": 200
}
HTTP/1.1 200 OK
{
"message": "Successful",
"data": {
"id": "61fb70e7dc1549da244670e2",
"type": "passport_facial",
"task_created_by": "Youcheck Online Services Limited",
"reference_id": "A111xxxxx",
"status": "found",
"response": {
"first_name": "FAMOUS",
"last_name": "EHICHIOYA",
"middle_name": "PRIOR",
"dob": "20001-01-01",
"mobile": null,
"photo": "data:image/jpg;base64,/9j/4AAQSkZJRgABAgEAAAAAAAD//gASSVJJUyBKUEVHIENPREV",
"gender": "male",
"issued_at": "IKOYI",
"issued_date": "2020-02-04T00:00:00.000Z",
"expiry_date": "2025-02-03T00:00:00.000Z",
"reference_id": "A111xxxxx",
"face_details": {
"confidence": 87,
"threshold": 70,
"request_image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAkACQAAD/4QDARXhpZgAASUkqA"
}
}
},
"status_code": 200
}
HTTP/1.1 200 OK
{
"message": "Successful",
"data": {
"id": "61fb74374999a6ded6e0b688",
"type": "bvn_facial",
"task_created_by": "Youcheck Online Services Limited",
"reference_id": "22328xxxxxx",
"status": "found",
"response": {
"first_name": "FAMOUS",
"middle_name": "PRIOR",
"mobile": "080362xxxxx",
"last_name": "EHICHIOYA",
"dob": "1956-04-04",
"photo": "data:image/jpg;base64,/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQND",
"subject_consent": true,
"reference_id": "22328xxxxxx",
"face_details": {
"confidence": 59,
"threshold": 70,
"request_image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAkACQAAD/4QDARXhpZgAASUkqAA"
}
}
},
"status_code": 200
}
HTTP/1.1 200 OK
{
"message": "Successful",
"data": {
"id": "61fb7301bd88acdd22c8fbd5",
"type": "nin_facial",
"task_created_by": "Youcheck Online Services Limited",
"reference_id": "90899xxxxxx",
"status": "found",
"response": {
"first_name": "FAMOUS",
"last_name": "EHICHIOYA",
"middle_name": "PRIOR",
"dob": "1960-04-04",
"mobile": "08036xxxxxx",
"reference_id": "90899xxxxxx",
"batch_id": null,
"birth_country": "nigeria",
"birth_lga": "Suleja",
"birth_state": "Niger",
"card_status": null,
"central_id": null,
"document_no": null,
"educational_level": null,
"employment_status": null,
"gender": "male",
"height": null,
"maiden_name": null,
"marital_status": null,
"nok_address1": "****",
"nok_address2": "",
"nok_firstname": "****",
"nok_lga": "****",
"nok_state": "****",
"nok_surname": "****",
"nok_town": "****",
"ospokenlang": "****",
"photo": "data:image/jpg;base64,/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQND",
"religion": "christianity",
"residence_address_line1": "OPPOSITE SULEIMAN BARAU TECHNICAL COLLEGE KWAMBA.",
"residence_town": null,
"residence_lga": "SULEJA",
"residence_state": "Niger",
"self_origin_lga": "Suleja",
"self_origin_place": "****",
"self_origin_state": "Niger",
"signature": "data:image/jpg;base64,/9j/4AAQSkZJRgABAQEAlgCWAAD/2wBDAAgGBgcGBQgHBwcJCQgK",
"tracking_id": null,
"face_details": {
"confidence": 55,
"threshold": 70,
"request_image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAkACQAAD/4QDARXhpZgAASUkqAAgAAAAFA"
}
}
},
"status_code": 200
}
HTTP/1.1 404 Not Found
{
"message": "No Result was found",
"name": "LegacyAPIError",
"status_code": 404
}
HTTP/1.1 503 Internal Server Error
{
"message": "Third-party provider not reacheable",
"name": "LegacyAPIError",
"status_code": 503
}
HTTP/1.1 400 Bad Request
{
"message": "Could not resolve account name. Check parameters or try again.",
"name": "LegacyAPIError",
"status_code": 400
}
Last updated