tranx_id (see Transaction references).| Endpoint | Send | Get back |
POST /kyc/verify_bvn | bvn, optional names | Full BVN record |
POST /kyc/verify_bvn_v2 | bvn only | Full BVN record |
POST /kyc/verify_bvn_bool | bvn, firstname, lastname | Record if the names match |
POST /kyc/validate_bvn | bvn, firstname, lastname | Personal info if the names match |
POST /kyc/verify_bvn_compare | bvn, names, client_image | Record plus face match score |
1{ "bvn": "22212345678", "tranx_id": "ACME-KYC-0000000101" }
{ "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.verify_bvn_bool and validate_bvn compare your first and last name with the BVN record.200 name matching was successful.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.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.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.| HTTP | message |
400 | invalid BVN provided... please try again |
400 | BVN record not found. please contact support or try again. |
417 | duplicate transaction detected.... |