Skip to main content
POST
/
api
/
v1
/
kyc
/
bvn
/
verify
Verify a BVN (Bank Verification Number)
curl --request POST \
  --url https://dev-api-partner.onecluster.co/api/v1/kyc/bvn/verify \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "bvn": "22212345678",
  "nameToMatch": "Adebayo Johnson"
}
'
{
  "success": true,
  "responseCode": "00",
  "message": "BVN verified",
  "data": {
    "match": true,
    "bvnMasked": "****5678",
    "nameMatchScore": 0.95,
    "dobMasked": "25/06/****",
    "phoneMasked": "****4567"
  }
}

Authorizations

​
Authorization
string
header
required

Your API key, formatted as: ApiKey ubn_sb_your_key_here

  • Sandbox keys start with ubn_sb_
  • Production keys start with ubn_pk_
  • Never use production keys during testing — they will charge real money

Headers

​
X-Correlation-ID
string<uuid>

A UUID v4 you generate to trace this request through our systems. If you don't provide one, we generate it for you. Always include it in support requests — it helps us find your request in logs.

Example:

"7f3a9c21-4e8b-4a12-b6d1-3c8a7f2e1b09"

​
X-Signature
string
required

Body

application/json
​
bvn
string
required

11-digit Bank Verification Number

Example:

"22212345678"

​
nameToMatch
string
required

Full name to match against the BVN record

Example:

"Adebayo Johnson"

Response

BVN verification result

Standard response wrapper for all successful API calls

​
success
boolean
required

Always true for successful responses

Example:

true

​
responseCode
string
required

00 means success

Example:

"00"

​
message
string
required

Human-readable description of the result

Example:

"Request processed successfully"

​
data
object
required

The actual response data (varies by endpoint)