NIN and Virtual NIN

This endpoint allows you to look up a virtual national identification number

Our endpoint provides a seamless and secure way for businesses to verify their customers’ virtual national ID number as well as their national ID number, ensuring their sensitive information is kept confidential.

This endpoint utilizes advanced technology to quickly verify your customers’ identity, granting you access to a range of exclusive benefits and services. With just a few clicks, you can verify your customers’ identity and guarantee a seamless experience. Please note that your customers must use either their NIN number or Identitypass's Enterprise code or ID (696739) on the NIMC mobile app to generate their VNIN before we can verify from our end.

The verification workflow for a virtual NIN can be performed using either of these processes:

Using NIMC App:

  1. The user inputs Identitypass's Enterprise code or ID (696739) on the NIMC mobile app
  2. The user scans the merchant QR code on the NIMC
  3. NIMC returns virtual NIN to the user on the NIMC mobile app
  4. User inputs virtual NIN on merchant's app

Using NIMC code:

  1. The user dial the USSD shortcode with an NIN-registered phone number
  2. NIMC returns NIN to the user via SMS/session message
  3. User inputs virtual NIN on merchant's app

📘

Note:

The Virtual NIN (vNIN) is designed to replace the raw 11-digit NIN for everyday usage. Where until now, the raw NIN had been shared and stored by various entities mostly without the knowledge (or consent) of the ID Holder or the Custodian of Identity in Nigeria, the NIMC.

Virtual NIN consists of 16 alpha-numeric characters that can be generated using:

  1. NIMC official mobile app
  2. USSD - _346_3_customer NIN_696739#

Identitypass Short Code: 696739

The responses for both NIN and vNIN are the same

👍

TEST DATA

number: 12345678901

OR

number_nin: 12345678901

📘

POST

{{URL}}/identitypass/verification/vnin

Request Header

KeyDescription
app-idYour App ID
x-api-keyYour Secret Key

Request Body

KeyDescription
numberVirtual NIN

OR

Request Body

KeyDescription
number_ninNIN

Sample Response

{
   "status":true,
   "detail":"NIN Verification Successfull",
   "response_code":"00",
   "nin_data":{
      "birthcountry":"string",
      "birthdate":"01-01-0001",
      "birthlga":"string",
      "birthstate":"string",
      "centralID":"string",
      "educationallevel":"string",
      "email":"",
      "employmentstatus":"string",
      "firstname":"string",
      "gender":"m",
      "heigth":"175",
      "maritalstatus":"single",
      "middlename":"",
      "nin":"00000000000",
      "nok_address1":"string",
      "nok_address2":"string",
      "nok_firstname":"string",
      "nok_lga":"string",
      "nok_middlename":"",
      "nok_postalcode":"",
      "nok_state":"string",
      "nok_surname":"string",
      "nok_town":"string",
      "ospokenlang":"string",
      "pfirstname":"",
      "photo":"base64_image_string",
      "pmiddlename":"string",
      "profession":"string",
      "psurname":"",
      "religion":"string",
      "residence_address":"string",
      "residence_lga":"string",
      "residence_state":"string",
      "residence_town":"string",
      "residencestatus":"string",
      "self_origin_lga":"string",
      "self_origin_place":"string",
      "self_origin_state":"string",
      "signature":"base64_image_string",
      "spoken_language":"string",
      "surname":"string",
      "telephoneno":"0801234567890",
      "title":"mr",
      "trackingId":"string",
      "userid":"string",
      "vnin":"string"
   }
}

Response Description

ResponseDescription
statusIndicates that the request was successful.
detailIndicates the detail of the response.
response_codeThe first name of the individual.
Nin_dataContains information related to the National Identification Number (NIN) data of an individual.
firstnameThe first name of the individual.
surnameThe surname or last name of the individual.
middlenameThe middle name of the individual.
birthdateThe date of birth of the individual (in the format DD-MM-YYYY).
useridThe user ID associated with the individual.
genderThe gender of the individual.
telephonenoThe telephone number of the individual.
vninThe verification national identification number of the individual.
self_origin_lgaThe local government area of the individual's place of origin.
heigthThe height of the individual.
birthstateThe state of birth of the individual.
signatureThe signature of the individual is not provided.
religionThe religious affiliation of the individual.
educationallevelThe educational level or qualification of the individual.
maritalstatusThe marital status of the individual.
self_origin_stateThe state of origin of the individual.
spoken_languageThe spoken language or languages of the individual.
trackingIdThe tracking ID associated with the individual.
self_origin_placeThe place of origin (city/town) of the individual.
residence_townThe town of residence of the individual.
nok_townThe town of residence of the individual's next of kin.
residence_stateThe state of residence of the individual.
residence_addressThe residential address of the individual.
birthcountryThe country of birth of the individual.
psurnameThe surname or last name of the individual's parent.
pfirstnameThe first name of the individual's parent.
nok_lgaThe local government area of the individual's next of kin.
nok_address2The address line 2 of the individual's next of kin.
nok_stateThe state of residence of the individual's next of kin.
nok_surnameThe surname or last name of the individual's next of kin.
nok_firstnameThe first name of the individual's next of kin.
ospokenlangThe spoken language or languages of the individual's next of kin.
residencestatusThe residency status of the individual.
pmiddlenameThe middle name of the individual's parent.
emailThe email address of the individual.
nok_postalcodeThe postal code of the individual's next of kin.
ninThe national identification number of the individual.
employmentstatusThe employment status of the individual.
birthlgaThe local government area of the individual's birthplace.
base64ImageThe person's image encoded in base64 format.
verificationProvides details about the verification process itself.
statusIndicates the status of the verification.
referenceA unique reference or identifier associated with the verification process. It can be used for tracking or reference purposes.