v1

latestOpenAPI 3.1.02026-07-2656114159.7 KB

Identity Verification

Basic BVN Verification

Verify a BVN against submitted identity details such as first name, middle name, last name, gender, date of birth, and phone number.

post/api/v1/merchant/bvn/basic

Headers

api-keystring required

Your Payvessel public API key

api-secretstring required

Your Payvessel secret

Content-Type'application/json' required

Request content type

Request body

bvnstring required

Customer BVN

first_namestring required

Customer first name

middle_namestring required

Customer middle name

last_namestring required

Customer last name

gender'MALE' | 'FEMALE' required

Customer gender

birthdaystring date required

Customer date of birth

phone_numberstring required

Customer phone number

Example request

{
  "bvn": "22123456789",
  "first_name": "John",
  "middle_name": "Adebayo",
  "last_name": "Doe",
  "gender": "MALE",
  "birthday": "1992-08-14",
  "phone_number": "08012345678"
}

Response

BVN verification response

successboolean required

Whether the request completed successfully

messagestring required

Response message

Example response

{
  "success": true,
  "message": "BVN verification completed successfully",
  "data": {
    "name_match_rlt": "MATCH",
    "names_match_percentage": "96",
    "birthday_match_rlt": "MATCH",
    "gender_match_rlt": "MATCH",
    "phone_number_match_rlt": "MATCH"
  },
  "charges": {
    "charged_amount": "0.00"
  }
}