Skip to main content
POST
/
api
/
onboarding
/
nigeria_kyc
/
bvn_advanced
BVN Advanced
curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_advanced/ \
  --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 Advanced endpoint provides a comprehensive view of a customer’s identity. In addition to standard BVN fields, it returns enrollment details, watchlist status, residential address, and a base64-encoded customer photo.

​
Endpoint

POST /api/onboarding/nigeria_kyc/bvn_advanced/

​
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_advanced/" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bvn": "22000000001"}'

​
Response

​
200 OK

FieldTypeDescription
data.bvnstringThe BVN that was queried
data.imagestringBase64-encoded JPEG of the customer’s registered photo
data.titlestringHonorific (e.g., "Mr", "Mrs")
data.genderstring"male" or "female"
data.lastNamestringCustomer’s last name
data.firstNamestringCustomer’s first name
data.middleNamestringCustomer’s middle name
data.dateOfBirthstringDate of birth in YYYY-MM-DD format
data.phoneNumber1stringPrimary registered phone number
data.phoneNumber2stringSecondary phone number (if available)
data.maritalStatusstringe.g., "Single", "Married"
data.lgaOfOriginstringLocal government area of origin
data.stateOfOriginstringState of origin
data.stateOfResidencestringState of current residence
data.lgaOfResidencestringLGA of residence (if available)
data.residentialAddressstringResidential address (if available)
data.enrollmentBankstringBank code where BVN was enrolled
data.enrollmentBranchstringBranch where BVN was enrolled
data.registrationDatestringDate of BVN registration
data.levelOfAccountstringCBN account tier level
data.watchListedstring"YES" if on a watchlist, otherwise "NO"
{
  "status": "success",
  "data": {
    "bvn": "22000000001",
    "image": "<base64-encoded-jpeg>",
    "title": "Mr",
    "gender": "male",
    "lastName": "OMOLE",
    "firstName": "ABRAHAM",
    "middleName": "ISAAC",
    "nameOnCard": "",
    "dateOfBirth": "1909-09-19",
    "lgaOfOrigin": "Ado-Odo/Ota",
    "watchListed": "NO",
    "phoneNumber1": "09011001100",
    "phoneNumber2": "",
    "maritalStatus": "Single",
    "stateOfOrigin": "Ogun State",
    "enrollmentBank": "033",
    "levelOfAccount": "Level 1 - Low Level Accounts",
    "lgaOfResidence": "",
    "enrollmentBranch": "0517-OTA 2",
    "registrationDate": "2017-09-05",
    "stateOfResidence": "Ogun State",
    "residentialAddress": ""
  },
  "message": "Bank Verification Number details retrieved successfully"
}

​
400 Bad Request

{
  "status": "failed",
  "data": [],
  "message": "Sorry, your check cannot be processed at the moment. Please try again in a few minutes"
}

​
401 Unauthorized

{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}

Authorizations

​
x-access-token
string
header
required

Your Adhere API secret key

Body

application/json
​
bvn
string
required

11-digit Bank Verification Number

Example:

"22244545518"

Response

BVN advanced data retrieved