BVN
Ensures customer's are who they claim to be
The BVN endpoint has a set of fields that are available to verify the user's Bank Verification Number and also helps your business for KYC (Know Your Customer) and user verification purposes. This can also be used for auto-completing account data and helps in reducing fraud. Personal information such as name, phone number, date of birth, national identification number (NIN), local government area of Origin, state of origin, image, and more. Bank Verification Number (BVN) can be returned to help identify the user from a specific financial institution.
API Object​
Response
{
"status": "success",
"code": 0,
"data": {
"bvn": "1234567899",
"firstName": "John ",
"middleName": "Doe ",
"lastName": "Jane",
"dateOfBirth": "1997-12-30T23:00:00.000Z",
"registrationDate": null,
"enrollmentBank": "033",
"enrollmentBranch": "OBAAKRAN",
"email": "",
"gender": "Male",
"levelOfAccount": "Level 2 - Medium Level Accounts",
"lgaOfOrigin": "Oshimili North",
"lgaOfResidence": "Ikeja",
"maritalStatus": "Single",
"nin": "1212121212",
"nameOnCard": "John Doe Jane",
"nationality": "Nigeria",
"phoneNumber1": "0801234567",
"phoneNumber2": "",
"residentialAddress": "address",
"stateOfOrigin": "Delta State",
"stateOfResidence": "Lagos State",
"title": "",
"watchListed": "NO",
"base64Image": "/9j/4AAQSkZJRgABAgAAAQABAADjEl5AfMXcMZNSy+GkhtIJ21EN5ueFi6Y/GnysXNEwaTFdAdAsUslnN3OzF9pHAHT/AOtSpoulNaTOz3G9MY/ee+PSnySJ9pE57IppdR1YV0lvpmlmOYNAzssZZcuc5/Cp9MtLM3QRbMEEHGATzjin7Nh7RHJhwxwp3H0HNTx2V5MMx2N0w9RC2P5V1FoJRdRiS2kC7gGG0025S4S6kAhbarkAH0zR7PzF7XyOfXR9TZcixlA/2sL/ADNUL63ntZhFcRGNyAwBIOR65H0NbWqhxey7kABIPb0rN1XBe2xn/UDqc/xNUNWNFK5UUvgcCl+f2FPA4FKaRRHtc/xUbT3Y1JikNADNgx3o2in9aQ0gE2j0owPSnE8U2gDQ3t/dpCz+gp9FMZHlz2FRyb9hIIBqY1HIMxtmgRFbhzEMtzmpdrf3jUdr/qj8xPzGpqAG7D/eNRvDxkHmpqKAIo8MOc5+tSbB6UxhtO5akVgwzQABF9KCq+lGcUE0AJgUUZooAMUUUUAFJS0lAh8btDKksZw6MGU+hFd9fx22qaNHqDlwwjBG09OeRXn+a7LwjcpdWU+"
}
}
BVN Fields​
Field | Description | Type |
---|---|---|
status | This is the returned status of the request either success or failed | string |
code | This is the operational code | number |
data | This is an array of objects which contains every transaction data | string |
data.bvn | The Bank verification number of a connected customer. | string |
data.firstName | The first name of a connected customer. | string |
data.middleName | The middle name of a connected customer. | string |
data.lastName | The last name of a connected customer. | string |
data.dateOfBirth | The date of birth of a connected customer. | string |
data.registrationDate | The date the BVN was created. | string |
data.enrollmentBank | The Bank where the user registered the BVN | string |
data.enrollmentBranch | The Bank Branch where the user registered the BVN | string |
data.email | The email address of a connected customer. | string |
data.gender | The gender of a connected customer. | string |
data.levelOfAccount | The connected customer's account level (e.g: Medium Level) | string |
data.lgaOfOrigin | The Local Government Area of Origin of the connected customer. | string |
data.lgaOfResidence | The Local Government Area of the connected customer's Residence. | string |
data.maritalStatus | The marital status of a connected customer whether single, married etc. | string |
data.nin | The National Identification Number (NIN) of the connected customer. | string |
data.nameOnCard | The full name on the card of the connected customer. | string |
data.nationality | The nationality of the connected customer. | string |
data.phoneNumber1 | The first phone number of a connected customer. | string |
data.phoneNumber2 | The second phone number of a connected customer. | string |
data.residetialAdddress | The provided home address of a connected customer. | string |
data.stateOfOrigin | The State of Origin of the connected customer. | string |
data.stateOfResidence | The State of the connected customer's Residence. | string |
data.title | The title of the connected customer (e.g: Mr, Mrs, Engr, etc). | string |
data.watchListed | The state of the connected customer; watchlisted or not. | boolean |
data.base64Image | The image of the connected customer. | string |