Bank Verification Number (BVN) - Adhere by Smartcomply

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

import requests

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

payload = { "bvn": "22244545518" }
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'})
};

fetch('https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn/', 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/",
  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'
  ]),
  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/"

	payload := strings.NewReader("{\n  \"bvn\": \"22244545518\"\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/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bvn\": \"22244545518\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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}"

response = http.request(request)
puts response.read_body

{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}

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

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

import requests

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

payload = { "bvn": "22244545518" }
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'})
};

fetch('https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn/', 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/",
  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'
  ]),
  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/"

	payload := strings.NewReader("{\n  \"bvn\": \"22244545518\"\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/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bvn\": \"22244545518\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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}"

response = http.request(request)
puts response.read_body

{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}

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

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

Header	Value	Required
`x-access-token`	Your API secret key	Yes
`Content-Type`	`application/json`	Yes

Body Parameters

Parameter	Type	Required	Description
`bvn`	string	Yes	The 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"}'

const response = await fetch(
  "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn/",
  {
    method: "POST",
    headers: {
      "x-access-token": "YOUR_SECRET_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ bvn: "22000000001" }),
  }
);
const data = await response.json();

import requests

response = requests.post(
    "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn/",
    headers={
        "x-access-token": "YOUR_SECRET_KEY",
        "Content-Type": "application/json",
    },
    json={"bvn": "22000000001"},
)
data = response.json()

Response

200 OK

Field	Type	Description
`status`	string	`"success"` on a successful verification
`data.lastName`	string	Customer’s last name as registered
`data.firstName`	string	Customer’s first name as registered
`data.middleName`	string	Customer’s middle name
`data.dateOfBirth`	string	Date of birth in `YYYY-MM-DD` format
`data.phoneNumber1`	string	Primary registered phone number
`message`	string	Human-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

​Endpoint

​Request

​Headers

​Body Parameters

​Example

​Response

​200 OK

​400 Bad Request

​401 Unauthorized

Authorizations

Body

Response

Endpoint

Request

Headers

Body Parameters

Example

Response

200 OK

400 Bad Request

401 Unauthorized