Skip to main content
POST
/
api
/
v1
/
merchant
/
bvn
/
basic
Basic BVN Verification
curl --request POST \
  --url https://api.payvessel.com/kyc/api/v1/merchant/bvn/basic \
  --header 'Content-Type: <content-type>' \
  --header 'api-key: <api-key>' \
  --header 'api-secret: <api-secret>' \
  --data '
{
  "bvn": "22123456789",
  "first_name": "John",
  "middle_name": "Adebayo",
  "last_name": "Doe",
  "gender": "MALE",
  "birthday": "1992-08-14",
  "phone_number": "08012345678"
}
'
{
  "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": false,
    "charged_amount": "0.00"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.payvessel.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
api-key
string
required

Your PayVessel API key

​
api-secret
string
required

Your PayVessel API secret

​
Content-Type
enum<string>
required

Request content type

Available options:
application/json

Body

application/json
​
bvn
string
required

Customer BVN

Example:

"22123456789"

​
first_name
string
required

Customer first name

Example:

"John"

​
middle_name
string
required

Customer middle name

Example:

"Adebayo"

​
last_name
string
required

Customer last name

Example:

"Doe"

​
gender
enum<string>
required

Customer gender

Available options:
MALE,
FEMALE
Example:

"MALE"

​
birthday
string<date>
required

Customer date of birth

Example:

"1992-08-14"

​
phone_number
string
required

Customer phone number

Example:

"08012345678"

Response

BVN verification response

​
success
boolean
required

Whether the request completed successfully

Example:

true

​
message
string
required

Response message

Example:

"BVN verification completed successfully"

​
data
object
required
​
charges
object
required