Skip to main content
PATCH
/
api
/
v1
/
customer
/
{customerId}
/
kyc
Update customer KYC information
curl --request PATCH \
  --url https://staging.afx-server.com/api/v1/customer/{customerId}/kyc \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "kyc": {
    "PASSPORT": "passport.png",
    "DATE_OF_BIRTH": "2000-01-01",
    "COUNTRY": "KE"
  }
}
'
{
  "data": {
    "customerId": "<string>",
    "fullName": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "countryCode": "<string>",
    "kyc": {},
    "meta": {}
  }
}
Update a customer’s KYC (Know Your Customer) information. Use this endpoint to add or update verification documents for a customer.

Authorizations

​
x-api-key
string
header
required

Static business API key from the dashboard

Path Parameters

​
customerId
string
required

The unique identifier of the customer

Body

application/json
​
kyc
object

Customer KYC object in a key-value format. Key should be one of the allowed KYC doc types

Example:
{
  "PASSPORT": "passport.png",
  "DATE_OF_BIRTH": "2000-01-01",
  "COUNTRY": "KE"
}

Response

Customer updated successfully.

​
data
object