Agent-readable docs index: /llms.txt. Full docs in one file: /llms-full.txt. Download /docs.zip to grep all markdown files locally.

KYC API: BVN lookup, name matching and selfie checks

Verify customers against their Bank Verification Number (BVN). Each call is charged to your wallet, so cache results on your side. Every request takes a tranx_id (see Transaction references).
EndpointSendGet back
POST /kyc/verify_bvnbvn, optional namesFull BVN record
POST /kyc/verify_bvn_v2bvn onlyFull BVN record
POST /kyc/verify_bvn_boolbvn, firstname, lastnameRecord if the names match
POST /kyc/validate_bvnbvn, firstname, lastnamePersonal info if the names match
POST /kyc/verify_bvn_comparebvn, names, client_imageRecord plus face match score

BVN lookup

POST /kyc/verify_bvn_v2
{ "bvn": "22212345678", "tranx_id": "ACME-KYC-0000000101" }
Response (shortened)
{ "status": "success", "message": "BVN retrieved successfully", "data": { "bvn_data": { "bvn": "22212345678", "bvn_data": { "bvn_number": "22212345678", "verification_status": "VERIFIED", "watchlisted": "NO", "personal_info": { "first_name": "ADEBAYO", "middle_name": "JOHN", "last_name": "OLUWASEUN", "gender": "Male", "phone_number": "08031234567", "formatted_date_of_birth": "1990-04-12" }, "residential_info": { "state_of_residence": "Lagos State", "residential_address": "12 Allen Avenue, Ikeja" } } } } }
watchlisted is YES when the BVN is on the banks' fraud watchlist. Treat those customers with extra care.

Name matching

verify_bvn_bool and validate_bvn compare your first and last name with the BVN record.
  • Match: HTTP 200 name matching was successful.
  • No match: HTTP 400 unable to verify BVN with your account name (verify_bvn_bool).
verify_bvn_bool returns the stored record with bvn_data as a JSON string. Decode it before reading fields.

Selfie comparison

verify_bvn_compare compares a selfie with the BVN photo. client_image is the file name of a selfie already stored with SendCheap, not a base64 image. Contact business@sendcheap.ng to set up selfie upload for your account.
The response's facial_data lists matching faces with a Similarity score from 0 to 100. An empty list means no match. Choose your own threshold; 90 or higher is common.

Errors

HTTPmessage
400invalid BVN provided... please try again
400BVN record not found. please contact support or try again.
417duplicate transaction detected....