Customers

Verify a customer document

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.

post/api/v1/customer/{customerId}/verify

Request

Base URL
https://sandbox.api.afriex.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/customer/:customerId/verify/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

customerIdstring required

The unique identifier of the customer

Request body

docType'BVN' required

The type of document to verify.

docValuestring required

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.

Response

Customer verified successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.