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>"
}
'
import requests

url = "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_with_face/"

payload = {
    "bvn": "22244545518",
    "image_url": "<string>"
}
headers = {
    "x-access-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({bvn: '22244545518', image_url: '<string>'})
};

fetch('https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_with_face/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_with_face/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bvn' => '22244545518',
    'image_url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_with_face/"

	payload := strings.NewReader("{\n  \"bvn\": \"22244545518\",\n  \"image_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-access-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_with_face/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bvn\": \"22244545518\",\n  \"image_url\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_with_face/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bvn\": \"22244545518\",\n  \"image_url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}
{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}
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"}'
const response = await fetch(
  "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_with_face/",
  {
    method: "POST",
    headers: { "x-access-token": "YOUR_SECRET_KEY", "Content-Type": "application/json" },
    body: JSON.stringify({ bvn: "22000000001", image_upload: "https://example.com/photo.jpg" }),
  }
);
import requests
response = requests.post(
    "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_with_face/",
    headers={"x-access-token": "YOUR_SECRET_KEY", "Content-Type": "application/json"},
    json={"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