Bank Verification Number (BVN)
Please note that when using your test key, Our test persona is John Doe and his Bank Verification Number as 10000000001. Hence all matching done with your test keys with details other than that of our Test Persona would simulate a failed identity matching.
postVerify BVN
post
https://vapi.verifyme.ng/v1/verifications/identities/bvn/:ref
Request
Response
Request
Path Parameters
ref
required
string
BVN Number
Headers
Authorization
required
string
Authorization Header
Query Parameters
type
optional
string
This refers to the payload type ie premium` or basic
Body Parameters
dob
optional
string
Date Of Birth
lastname
required
string
Lastname to verify
firstname
required
string
Firstname to verify
Response
200: OK
For premium payload type
{"status": "success","data": {"fieldMatches":{"firsname":false,"lastname":false,"dob":false}"bvn": 10000000001,"firstname": "John","lastname": "Doe","middlename": "Jane""phone": "08066676673","gender": "female""birthdate": "04-04-1944","photo": "Base64 Encoded","maritalStatus": "Single","lgaOfResidence": "Surulere","lgaOfOrigin": "Ijebu ode","residentialAddress": "1 jameson street","stateOfOrigin": "Ogun State","enrollmentBank": "058","enrollmentBranch": "BODIJA","nameOnCard": "JOHN DOE","title": "Mr","levelOfAccount": "Level 2 - Medium Level Accounts",}}
404: Not Found
{"code":"NOT_FOUND_ERROR","message":"BVN provided is not found. Please provide a valid bvn"}
​
Sample Request
Curl
Curl
curl --location --request POST 'https://vapi.verifyme.ng/v1/verifications/identities/bvn/10000000001' \--header 'Authorization: Bearer <your secret key>' \--header 'Content-Type: application/json' \--data-raw '{"firstname":"John","lastname":"Doe","phone":"080000000000","dob":"04-04-1944"}'
We have 2 types of payload responses for bvn verifications
Premium
Basic
basic response
premium response
basic response
{"status": "success","data": {"bvn": "22515263226","firstname": "JOHN","lastname": "DOE","middlename": "JAMES","gender": "Male","phone": "08100000000","birthdate": "31-05-2000","photo": "<base64 image>","fieldMatches": {"firstname": false,"lastname": false}}}
premium response
{"status": "success","data": {"bvn": 10000000001,"firstname": "John","lastname": "Doe","middlename": "Jane""phone": "08066676673","gender": "female""birthdate": "17/01/1988","photo": "Base64 Encoded","maritalStatus": "Single","lgaOfResidence": "Surulere","lgaOfOrigin": "Ijebu ode","residentialAddress": "1 jameson street","stateOfOrigin": "Ogun State","enrollmentBank": "058","enrollmentBranch": "BODIJA","nameOnCard": "JOHN DOE","title": "Mr","levelOfAccount": "Level 2 - Medium Level Accounts","fieldMatches":{"firsname":false,"lastname":false,"dob":false}}}