Virtual National Identification Number (vNIN)

vNIN Lookup API

To perform a verification on a Virtual National Identification Number (vNIN), make a POST request to the vNIN Lookup endpoint;

https://api.korapay.com/merchant/api/v1/identities/ng/vnin

vNIN Data Validation

vNIN data validation enables you to verify a vNIN 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 vNIN 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.

vNIN Facial Matching

vNIN facial matching enables you to match the vNIN 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": "Virtual NIN verified successfully",
   "data": {
       "reference": "VR-r5xFj7cjmL4yvSAGR",
       "id": "KO111111111111IL",
       "id_type": "ng_vnin",
       "first_name": "Angela",
       "last_name": "Chukwudobe",
       "middle_name": "Obiageli",
       "date_of_birth": "2000-10-01",
       "phone_number": "2341234567890",
       "v_nin_user_id": "ABCDEF-8930",
       "gender": "female",
       "image": "data:image/jpeg;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"
   }
}