Skip to main content
POST
Afriex SDK
Verification is limited to 100 requests per 24 hours for each business, in production and sandbox. If you exceed the limit, the endpoint returns 429 Too Many Requests with a Retry-After header. See Rate limits.
If the customer already has a document of this type on file, docValue must match it. A different value returns 400 with INVALID_KYC_DOCUMENT_TYPE.

Authorizations

x-api-key
string
header
required

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

x-api-signature
string

Signature of the request payload, used for request authentication where payload signing is enabled for your business.

x-api-version
string

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

customerId
string
required

The unique identifier of the customer

Body

application/json
docType
enum<string>
required

The type of document to verify.

Available options:
BVN
docValue
string
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.

Minimum string length: 1
Pattern: ^\d{11}$

Response

Customer verified successfully.

data
object