Skip to main content
POST
/
api
/
onboarding
/
nigeria_kyc
/
bvn
BVN Verification
curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "bvn": "22244545518"
}
'
{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}

Documentation Index

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

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

The BVN endpoint verifies a customer’s Bank Verification Number and returns their registered personal details from the Central Bank of Nigeria’s database. Use this for KYC onboarding, identity confirmation, and fraud prevention.

​
Endpoint

POST /api/onboarding/nigeria_kyc/bvn/

​
Request

​
Headers

HeaderValueRequired
x-access-tokenYour API secret keyYes
Content-Typeapplication/jsonYes

​
Body Parameters

ParameterTypeRequiredDescription
bvnstringYesThe customer’s 11-digit Bank Verification Number

​
Example

curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn/" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bvn": "22000000001"}'

​
Response

​
200 OK

FieldTypeDescription
statusstring"success" on a successful verification
data.lastNamestringCustomer’s last name as registered
data.firstNamestringCustomer’s first name as registered
data.middleNamestringCustomer’s middle name
data.dateOfBirthstringDate of birth in YYYY-MM-DD format
data.phoneNumber1stringPrimary registered phone number
messagestringHuman-readable result summary
{
  "status": "success",
  "data": {
    "lastName": "OMOLE",
    "firstName": "ABRAHAM",
    "middleName": "ISAAC",
    "dateOfBirth": "1909-09-19",
    "phoneNumber1": "09011001100"
  },
  "message": "Bank Verification Number details retrieved successfully"
}

​
400 Bad Request

Returned when the BVN is missing, malformed, or not found in the database. 
{
  "status": "failed",
  "data": [],
  "message": "Sorry, your check cannot be processed at the moment. Please try again in a few minutes"
}

​
401 Unauthorized

Returned when the x-access-token header is missing or invalid. 
{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}
For a full list of error codes, see the Error Codes reference.

Authorizations

​
x-access-token
string
header
required

Your Adhere API secret key

Body

application/json
​
bvn
string
required

11-digit Bank Verification Number

Required string length: 11
Example:

"22244545518"

Response

BVN verified successfully