NIN Verification

1.0 AUTHORIZATION

This api requires an access token. To get more info on how to generate this access token, click on Generating Access Token

2.0 BASE URL

All requests to the Wallet API in the test environment must be done using the web API URL below.

Test Environment: https://api-devapps.vfdbank.systems/vtech-kyc/api/v2/kyc

LIVE Environment: https://api-apps.vfdbank.systems/vtech-kyc/api/v2/kyc

3.0 HOW TO USE THE NIN API

1. The developer should call the VERIFY NIN api to verify an nin

3.1 VERIFY NIN

API Context: /verify/nin

Description: This endpoint is used for NIN verification.

API METHOD: POST

REQUEST HEADERS

Key	Value
AccessToken	{{token}}

SAMPLE REQUEST

{
    "idNumber":"11111222221"
}

Field	Description	Status
idNumber	NIN to verify	Mandatory

SAMPLE RESPONSE

{
    "status":"00",
    "message":"Successful",
    "data":{
        "valid": true,
        "idNumber": "45629461922",
        "gender": "m",
        "phoneNumber": "08132741111",
        "fullName": "Jude Paul Thomas",
        "firstName": "Jude",
        "lastName": "Thomas",
        "middleName": "Paul",
        "dateOfBirth": "1997-10-20",
        "address": "Not Available",
        "expiryDate": "Not Available",
        "photo":"base64 image string",
        "available": true,
        "firstNameMatch": false,
        "lastNameMatch": false,
        "dobMatch": false
    }
}