const customer = await afriex.customers.verify("customer-id", {
docType: "BVN",
docValue: "22222222222",
});curl --request POST \
--url https://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"docType": "BVN",
"docValue": "22222222222"
}
'import requests
url = "https://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify"
payload = {
"docType": "BVN",
"docValue": "22222222222"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({docType: 'BVN', docValue: '22222222222'})
};
fetch('https://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify', 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://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify",
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([
'docType' => 'BVN',
'docValue' => '22222222222'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify"
payload := strings.NewReader("{\n \"docType\": \"BVN\",\n \"docValue\": \"22222222222\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"docType\": \"BVN\",\n \"docValue\": \"22222222222\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"docType\": \"BVN\",\n \"docValue\": \"22222222222\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"name": "Jane Smith",
"email": "jane.smith@example.com",
"phone": "+2348192837465",
"customerId": "69d5ffe1ab82306f11b032f3",
"reference": "afx121011",
"countryCode": "NG",
"meta": {
"kyc": {
"data": {
"BVN": "22222222222"
}
}
},
"createdAt": "2026-04-08T07:12:33.519Z",
"updatedAt": "2026-04-08T07:21:09.872Z"
}
}Verify Customer
Runs an identity verification against a customer document. Today the only supported docType is BVN (Nigeria); docValue is the document number. Verification is rate limited per business. The 200 response carries the customer’s stored KYC documents in meta.kyc.data.
const customer = await afriex.customers.verify("customer-id", {
docType: "BVN",
docValue: "22222222222",
});curl --request POST \
--url https://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"docType": "BVN",
"docValue": "22222222222"
}
'import requests
url = "https://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify"
payload = {
"docType": "BVN",
"docValue": "22222222222"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({docType: 'BVN', docValue: '22222222222'})
};
fetch('https://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify', 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://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify",
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([
'docType' => 'BVN',
'docValue' => '22222222222'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify"
payload := strings.NewReader("{\n \"docType\": \"BVN\",\n \"docValue\": \"22222222222\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"docType\": \"BVN\",\n \"docValue\": \"22222222222\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.afriex.com/api/v1/customer/{customerId}/verify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"docType\": \"BVN\",\n \"docValue\": \"22222222222\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"name": "Jane Smith",
"email": "jane.smith@example.com",
"phone": "+2348192837465",
"customerId": "69d5ffe1ab82306f11b032f3",
"reference": "afx121011",
"countryCode": "NG",
"meta": {
"kyc": {
"data": {
"BVN": "22222222222"
}
}
},
"createdAt": "2026-04-08T07:12:33.519Z",
"updatedAt": "2026-04-08T07:21:09.872Z"
}
}429 Too Many Requests with a Retry-After header. See Rate limits.docValue must match it. A different value returns 400 with INVALID_KYC_DOCUMENT_TYPE.Authorizations
Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Manage your keys and their permissions under Developer → API keys in the dashboard.
A request whose key does not carry the permission the target
endpoint requires is rejected with 401 Unauthorized, the same
response an unrecognised, malformed, revoked or disabled key
returns. The API does not distinguish the two cases on the wire.
See the Permissions reference for the permission each endpoint requires.
Headers
Signature of the request payload, used for request authentication where payload signing is enabled for your business.
API version in ISO 8601 format. The only supported version is 2026-05-18, which is also the default when the header is omitted. Any other value is rejected with a 400 Bad Request.
Path Parameters
The unique identifier of the customer
Body
The type of document to verify.
BVN The document number to verify. A BVN must be exactly 11 digits and its registered name must match the customer's name. A malformed BVN is rejected with 400, not 422.
1^\d{11}$Response
Customer verified successfully.
Show child attributes
Show child attributes
