Virtual NIN (vNIN)

vNIN is a tokenized version of a user's actual NIN implemented by NIMC. The virtual NIN allows third parties to verify a user's NIN details without putting the user's data at risk.

Please note that when using your test key, Our test persona is John Doe and his vNIN is JZ426633988976CH. Hence all matching done with your test keys with details other than our Test Persona would simulate a failed identity matching.

3. Please note that the applicant needs to generate the virtual NIN by themselves on the NIMC mobile app in other to use this endpoint.

They will need Verifyme's shortCode to generate the vNIN successfully, the short-code is 715461

Generate vNIN via USSD

Dial *346* 3* Your NIN* AgentCode# An SMS message will be sent back to you containing the Virtual NIN generated for you.

Steps to generate vNIN through the NIMC app

1. Download the NIMC App

2. Click on "Get Virtual NIN"

3. Select "Input Enterprise short-code" and type 715461

4. Click "Submit" and your virtual NIN will be generated.

John Doe's matching test

ID_SAMPLE = {
    idNumber: 'JZ426633988976CH',
    firstname: 'John',
    lastname: 'Doe',
    dob: '04-04-1944',
    gender: 'male',
    phone: '[phone]'
}

JSON

{
    "firstname": "JOHN",
    "lastname": "Doe"
}

CURL

curl --location --request POST 'https://vapi.verifyme.ng/v1/verifications/identities/virtual-nin/JZ426633988976CH' \
--header 'Authorization: Bearer {your secret key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstname": "JOHN",
    "lastname": "DOe"
}
'

Virtual NIN

POST https://vapi.verifyme.ng/v1/verifications/identities/virtual-nin/:vNin

This endpoint is for verifying a customer's identity using their uniquely generated Virtual NIN (vNIN). The vNIN is generated from NIMC's mobile app and is tied to our Merchant ID.

Path Parameters

Name	Type	Description
vNin*	string	Virtual Nin

Headers

Name	Type	Description
Authorization*	string	Authorization Header

Request Body

Name	Type	Description
firstname	string	First name
phone	String	Phone number
dob	String	Date of birth
lastname	String	Last name
gender	String	Gender

201: Created Success response

{
    "status": "success",
    "data": {
        id: 1,
        firstname: 'John',
        lastname: 'Doe'
        birthdate: idSample.dob,
        gender: 'M',
        phone: '2341234567890',
        vNin: 'JZ426633988976CH',
        photo: 'https://verifyme-assets.s3.eu-west-2.amazonaws.com/placeholder.png'
    }
}

401: Unauthorized Unauthorized Error

{
    "statusCode": 401,
    "error": "Unauthorized"
}

404: Not Found vNIN not found

{
    "code":"NOT_FOUND_ERROR",
    "message":"vNin provided is not found. Please provide a valid vNIN"
}