Skip to main content
PATCH
Afriex SDK
Use it to add or update a customer’s verification documents.

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

A flat map of KYC document types to their values. Send the document map directly as the request body (do not wrap it in a kyc field). Each key must be one of the allowed KYC document types and each value is a string.

PHONE and COUNTRY are not accepted here; they are profile fields owned by PATCH /api/v1/customer/{customerId}. BVN is not accepted either; it is owned by POST /api/v1/customer/{customerId}/verify, which writes it only after a successful bank verification. Sending any of the three returns 400 INVALID_KYC_DOCUMENT_TYPE, as does an empty body.

Value rules: DATE_OF_BIRTH must be a valid YYYY-MM-DD date for a customer aged 13 to 75; every other value must be at least 2 characters. A value that breaks a rule returns 400 INVALID_KYC_DOCUMENT_TYPE.

{key}
string

Response

Customer updated successfully.

data
object