National Identification Number (NIN)
NIN Lookup API
To perform a verification on a National Identification Number (NIN), make a POST request to the NIN Lookup endpoint;
https://api.korapay.com/merchant/api/v1/identities/ng/nin
NIN Data Validation
NIN data validation enables you to verify a NIN and validate the information in the government database against the data parameters you provided when the verification request was made. You can validate the First name, Last name and DOB of the NIN holder by passing the information in the request body to get a true
or false
response when matched with the information in the database. Use the same endpoint above to make this request.
NIN Facial Matching
NIN facial matching enables you to match the NIN holder’s image in the government database against the image provided when the verification request was made. A confidence score of how well the images match will be returned. Use the same endpoint above to make this request.
The request body should have the following parameters:
{
"id": "KO111111111111IL",
"verification_consent": true
}
{
"id": "KO111111111111IL",
"verification_consent": true,
"validation": {
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "1988-04-04"
}
}
{
"id": "KO111111111111IL",
"verification_consent": true,
"validation": {
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "1988-04-04",
"selfie": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ"
}
}
The fields in this request include:
Field | Data Type | Description |
---|---|---|
id | String | Required - the ID number |
verification_consent | Boolean | Required - this indicates that subject has given consent to perform this verification. This must be true for the check to be performed. |
validation.first_name | String | Optional (required for data matching) - the first name of the ID holder to be compared with ID information in the government database. |
validation.last_name | String | Optional (required for data matching) - the last name of the ID holder to be compared with ID information in the government database. |
validation.date_of_birth | String | Optional (required for data matching) - the date of birth of the ID holder to be compared with ID information in the government database. |
validation.selfie | String | Optional (required for facial matching) - the selfie/photo of the ID holder to be compared with ID information in the government database. |
The response to this request would look like this:
{
"status": true,
"message": "NIN verified successfully",
"data": {
"reference": "VR-jmJuvnt6imoznOOtN",
"id": "55555555555",
"id_type": "ng_nin",
"first_name": "Bimbo",
"last_name": "Olakunle",
"middle_name": "Doherty",
"date_of_birth": "1988-04-04",
"phone_number": "08000000000",
"address": {
"town": "SULEJA",
"lga": "Suleja",
"state": "Niger",
"street": "13B Sample Street, Ilupeju Niger State"
},
"email": "[email protected]",
"birth_state": "Edo",
"birth_lga": "Esan West",
"birth_country": "nigeria",
"next_of_kin_state": "Niger",
"religion": "christianity",
"gender": "female",
"image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ",
"signature": "data:image/jpg;base64,/9j/4AAQSkZJRgABAQAAAQ",
"validation": {
"first_name": {
"value": "Viola",
"match": false
},
"last_name": {
"value": "doe",
"match": false
},
"date_of_birth": {
"value": "1988-10-16",
"match": false
},
"selfie": {
"value": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ",
"match": true,
"confidence_rating": 94
}
},
"requested_by": "API User"
}
}
Updated 3 months ago