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:
- The user inputs Identitypass's Enterprise code or ID (696739) on the NIMC mobile app
- The user scans the merchant QR code on the NIMC
- NIMC returns virtual NIN to the user on the NIMC mobile app
- User inputs virtual NIN on merchant's app
Using NIMC code:
- The user dial the USSD shortcode with an NIN-registered phone number
- NIMC returns NIN to the user via SMS/session message
- 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:
- NIMC official mobile app
- 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
Key | Description |
---|---|
app-id | Your App ID |
x-api-key | Your Secret Key |
Request Body
Key | Description |
---|---|
number | Virtual NIN |
OR
Request Body
Key | Description |
---|---|
number_nin | NIN |
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
Response | Description |
---|---|
status | Indicates that the request was successful. |
detail | Indicates the detail of the response. |
response_code | The first name of the individual. |
Nin_data | Contains information related to the National Identification Number (NIN) data of an individual. |
firstname | The first name of the individual. |
surname | The surname or last name of the individual. |
middlename | The middle name of the individual. |
birthdate | The date of birth of the individual (in the format DD-MM-YYYY). |
userid | The user ID associated with the individual. |
gender | The gender of the individual. |
telephoneno | The telephone number of the individual. |
vnin | The verification national identification number of the individual. |
self_origin_lga | The local government area of the individual's place of origin. |
heigth | The height of the individual. |
birthstate | The state of birth of the individual. |
signature | The signature of the individual is not provided. |
religion | The religious affiliation of the individual. |
educationallevel | The educational level or qualification of the individual. |
maritalstatus | The marital status of the individual. |
self_origin_state | The state of origin of the individual. |
spoken_language | The spoken language or languages of the individual. |
trackingId | The tracking ID associated with the individual. |
self_origin_place | The place of origin (city/town) of the individual. |
residence_town | The town of residence of the individual. |
nok_town | The town of residence of the individual's next of kin. |
residence_state | The state of residence of the individual. |
residence_address | The residential address of the individual. |
birthcountry | The country of birth of the individual. |
psurname | The surname or last name of the individual's parent. |
pfirstname | The first name of the individual's parent. |
nok_lga | The local government area of the individual's next of kin. |
nok_address2 | The address line 2 of the individual's next of kin. |
nok_state | The state of residence of the individual's next of kin. |
nok_surname | The surname or last name of the individual's next of kin. |
nok_firstname | The first name of the individual's next of kin. |
ospokenlang | The spoken language or languages of the individual's next of kin. |
residencestatus | The residency status of the individual. |
pmiddlename | The middle name of the individual's parent. |
The email address of the individual. | |
nok_postalcode | The postal code of the individual's next of kin. |
nin | The national identification number of the individual. |
employmentstatus | The employment status of the individual. |
birthlga | The local government area of the individual's birthplace. |
base64Image | The person's image encoded in base64 format. |
verification | Provides details about the verification process itself. |
status | Indicates the status of the verification. |
reference | A unique reference or identifier associated with the verification process. It can be used for tracking or reference purposes. |
Updated 7 months ago