NIN VERIFY

Overview

The NIN service accepts the NIN and country code of the customer and returns detailed information on the NIN verification. This article will guide you on how to integrate into the NIN Service

🚧
Important!
Before you proceed, ensure you review the prerequisites for integrating to our APIs for a more detailed guide

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 NIN will be passed into this field
countryCode	Optional	The Country would be passed into this field	NG
verificationType	Required	This field is used to identify the service being called. Ensure to use the value provided exactly as provided	NIN-VERIFY

{
    "verificationType":"NIN-VERIFY",
    "countryCode": "NG",
    "searchParameter":""
}

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 the 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 failed or Refund
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	NIN used for the verification
response	Json	This is a JSON containing all the actual NIN data as retrieved from the service provider

Successful Response Example

{
    "responseCode": "00",
    "description": "Successful",
    "verificationType": "NIN-VERIFY",
    "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",
        "photo": "Base64",
        "vnin": "SF895332826955L0",
        "vNIN": "SF895332826955L0"
    },
    "faceMatch": null,
    "licenseSessionId": null,
    "remainingLicenseSessionRound": null
}

Unsuccessful Verification

{
    "responseCode": "00",
    "description": "ID Provided is invalid",
    "verificationType": "NIN-VERIFY",
    "verificationStatus": "NOT VERIFIED",
    "transactionStatus": "SUCCESSFUL",
    "transactionReference": "1626687182780-L4ZK01U9",
    "transactionDate": "1656504490567",
    "searchParameter": "0000000000",
    "callBackUrl": null,
    "livenessScore": 0.0,
    "paymentRef": null,
    "response":null,
    "faceMatch": null,
    "licenseSessionId": null,
    "remainingLicenseSessionRound": null
}

System error

{
    "responseCode": "11",
    "description": "System Error,unexpected exception",
    "verificationType": null,
    "verificationStatus": null,
   "transactionStatus":null,
    "transactionReference": null,
    "transactionDate": null,
    "searchParameter": null,
    "response": null
}

Third-Party system Unavailable

{
    "responseCod": 15,
    "description": "Third Party System is Unavailable",
    "verificationType": "NIN-VERIFY",
    "verificationStatus": "NOT VERIFIED",
    "transactionStatus": "FAILED",
    "transactionReference": "null",
    "transactionDate": "null",
    "searchParameter": "null",
    "response":"null"
}

User Authentication

{
    "responseCode": "14",
    "description": "Deactivated UserID specified",
    "verificationType": null,
    "verificationStatus": null,
    "transactionStatus": null,
    "transactionReference": null,
    "transactionDate": null,
    "searchParameter": null,
    "response": null
}

Billing Error

{
    "responseCode": "11",
    "description": "A billing error occurred please contact support",
    "verificationType": "BVN-FULL-DETAILS",
    "verificationStatus": "PENDING",
    "transactionStatus": null,
    "transactionReference":"null"
    "transactionDate": "null",
    "searchParameter": "null"
    "response": null
}

Insufficient Balance

{
    "responseCode": "12",
    "description": "You have insufficient funds. Pls top-up your wallet",
    "verificationType": "NIN-VERIFY",
    "verificationStatus": "PENDING",
    "transactionStatus": null,
    "transactionReference": ""null"
    "searchParameter": "12345678910",
    "callBackUrl": null,
    "livenessScore": 0,
    "paymentRef": null,
    "response": null,
    "faceMatch": null,
    "licenseSessionId": null,
    "remainingLicenseSessionRound": 0
}

Search Parameter Failed to meet Minimum or Maximum Threshold

{
    "responseCode": 16,
    "description": "There were validation errors for VNIN Verification\\n\\n[Failed validation for searchParameter Min: 11, Max: 11, Required: true]",
    "verificationType": "NIN-VERIFY",
    "verificationStatus": "PENDING",
    "transactionStatus": "FAILED",
    "transactionReference": ""null"
    "transactionDate": "null"
    "searchParameter": "00000000",
    "response": ""
}

Unexpected System Error

{
    "responseCode": "11",
    "description": "Something unexpected happened. Please retry or contact support",
    "verificationType": null,
    "verificationStatus": "PENDING",
    "transactionStatus": "FAILED",
    "transactionReference": null,
    "transactionDate": null,
    "searchParameter": null,
    "response": null
}

User Has no API Access

{
    "responseCode": "13",
    "description": "Client has no api access",
    "verificationType": "NIN-VERIFY",
    "verificationStatus": "PENDING",
    "transactionStatus": null,
    "transactionReference": ""null"",
    "transactionDate": ""null"",
    "searchParameter": ""null"",
    "response": null
}

Invalid User ID

{
    "responseCode": "13",
    "description": "Invalid UserID specified",
    "verificationType": "NIN-VERIFY",
    "verificationStatus": "PENDING",
    "transactionStatus": null,
    "transactionReference": ""null"",
    "transactionDate": ""null"",
    "searchParameter": ""null"",
    "response": null
}

Overview

🚧Important!

API Endpoint

Headers

Request

Response

🚧
Important!