Virtual NIN 🇳🇬
Overview
The Virtual NIN service accepts the NIN and country code of the customer and returns detailed information on the Virtual NIN verification. This article will guide you on how to integrate to the Virtual NIN Service
Important!
Before you proceed, ensure you review the prerequisites for integrating to our APIs for a more detailed guide.
Virtual NIN Generation
Virtual NIN can be generated via the NIMC mobile App or via USSD. Use this to generate Virtual NIN to be verified.
Important!
You have to specify SEAMFIX as the enterprise while generating Virtual NIN on the NIMC mobile App or specify SEAMFIX Agent ID: 951641 while generating using USSD. Example: *346*3*Your NIN*951641#
API Endpoint
https://api.verified.africa/sfx-verify/v3/id-service/
Headers
Our service accepts headers for authentication. See below the headers to pass to the API
| Header | Type | Description |
|---|---|---|
| userid | String | This is your user id retrieved from the portal. Check the getting started article to understand how to retrieve your userid |
| apiKey | String | This is your api key retrieved from the portal. Check the getting started article to understand how to retrieve your apiKey |
Request
| Request Parameter | Status | Description | Test Data |
|---|---|---|---|
| searchParameter | Required | The Virtual NIN will be passed into this field | SF895332826955L0 |
| countryCode | Required | The Country would be passed into this field | NG |
| transactionReference | Optional | This is a field that uniquely identifies your transaction. We generate this field if you leave it empty; however, we encourage you to generate it for proper reconciliation | To be generated by the customer |
| verificationType | Required | This field is used to identify the service being called. Ensure to use the value provided exactly as provided | V-NIN |
{
"verificationType": "V-NIN",
"countryCode": "NG",
"transactionReference":"",
"searchParameter":"SF895332826955L0"
}
Response
| Response Parameter | Type | Description |
|---|---|---|
| responseCode | String | Please reference Response Codes page for details on all possible responses |
| description | String | This is a description of the response received. |
| verificationType | String | The same verificationType passed in request will be returned here |
| verificationStatus | String | This field lets you know if the identity verification was successful. Options are: VERIFIED: This means that the NIN is valid. NOT VERIFIED This means that the NIN is invalid PENDING This status means that the verification could not be completed. Refer to the responseCode for the specific failure reason |
| transactionStatus | String | This indicates the wallet debit status. The options are successful or failed. |
| transactionReference | String | If you supplied a transactionReference, the same will be returned here. Else, we would generate a reference and return that to you in this field. |
| transactionDate | String | Date the transaction was done |
| searchParameter | String | Virtual NIN used for the verification |
| response | Json | This is a json containing all the actual Virtual NIN data as retrieved from the service provider. |
{
"responseCode": "00",
"description": "Successful",
"verificationType": "V-NIN",
"verificationStatus": "VERIFIED",
"transactionStatus": "SUCCESSFUL",
"transactionReference": "1626687182780-L4ZK01U9",
"transactionDate": "1656504490567",
"searchParameter": "SF895332826955L0",
"callBackUrl": null,
"livenessScore": 0.0,
"paymentRef": null,
"response": {
"firstName": "PROUD",
"surname": "CITIZEN",
"middleName": "NIGERIAN",
"dateOfBirth": "01 OCT 1960",
"userid": "ABCDEF-8910",
"gender": "M",
"trustedNumber": "2341234567890",
"txid": "bd633743-cdb8-452f-b46b-55c63c81a605",
"ts": "2022-06-29T12:08:10.567",
"agentID": "ABCDEF-8910",
"vnin": "SF895332826955L0",
"vNIN": "SF895332826955L0"
},
"faceMatch": null
}
Updated about 1 year ago