Skip to main content
POST
/
api
/
onboarding
/
nigeria_kyc
/
bvn_with_face
BVN with Face
curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_with_face/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "bvn": "22244545518",
  "image_url": "<string>"
}
'
{
  "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 with Face endpoint verifies a customer’s Bank Verification Number and performs a facial comparison against a provided photo URL. It returns the full BVN profile plus a match confidence score.

​
Endpoint

POST /api/onboarding/nigeria_kyc/bvn_with_face/

​
Request

​
Headers

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

​
Body Parameters

ParameterTypeRequiredDescription
bvnstringYesThe customer’s 11-digit Bank Verification Number
image_uploadstringYesURL of the customer’s photo for facial comparison

​
Example

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

​
Response

​
200 OK

FieldTypeDescription
data.firstNamestringFirst name
data.lastNamestringLast name
data.dateOfBirthstringDate of birth
data.genderstringGender
data.bvnstringBVN number
data.watchListedbooleantrue if flagged on a watchlist
data.base64ImagestringBase64-encoded registered photo
data.face_data.statusbooleantrue if the faces match
data.face_data.confidencenumberMatch confidence percentage (0–100)
{
  "status": "success",
  "data": {
    "firstName": "ABRAHAM",
    "lastName": "OMOLE",
    "middleName": "ISAAC",
    "dateOfBirth": "19-Sept-1909",
    "phoneNumber1": "09011001100",
    "email": null,
    "gender": "Male",
    "stateOfOrigin": "Ogun State",
    "bvn": "22200000000",
    "nin": null,
    "registrationDate": "2017-09-05",
    "lgaOfOrigin": "Ado-Odo/Ota",
    "maritalStatus": "Single",
    "watchListed": false,
    "base64Image": "<base64-encoded-jpeg>",
    "face_data": {
      "status": true,
      "response_code": "00",
      "message": "Face Match",
      "confidence": 99.99
    }
  },
  "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"

​
image_url
string
required

URL of the selfie image

Response

BVN with face verified