Update customer
Customers
Update Customer
Partially update a customer. All body fields are optional; include only fields you want to change. Use documents and proof_of_funds for KYC updates.
PATCH
Update customer
Overview
Update an existing customer with a partial JSON body. Only include fields you want to change. Typical uses include correcting profile data, refreshing identity documents, and submitting proof-of-funds details.Request body
All fields are optional:| Field | Description |
|---|---|
date_of_birth | YYYY-MM-DD |
address | Same shape as on create customer; address.document is a base64 string when provided |
first_name, last_name, phone, gender, country_code | Profile fields |
documents | Array of document objects (see below) |
proof_of_funds | Employment and source-of-funds fields |
documents items
Each element uses the same shape as on create (see Identity documents):
id_type— One of:passport,resident_id,drivers_license,national_id,voters_card,nin,bvn, or a tax ID type (see Tax ID document)id_number— Value on the documentfront_doc— Base64-encoded image of the frontback_doc— Base64-encoded image of the back when needed
passport, resident_id, drivers_license, national_id, voters_card, and nin, you need at most front_doc (base64); back_doc is not required for those types.
proof_of_funds
Optional object with: employment_status, occupation, primary_purpose, source_of_funds, expected_monthly_pay.
Use the Field values from the reference tables in your JSON (not free-text labels). See Proof of funds options.Authorizations
API key for authentication.
Path Parameters
The ID of the customer to retrieve.
Body
application/json
Partial update payload. All properties are optional.
Date of birth (YYYY-MM-DD)
Customer first name
Customer last name
Customer phone number
Customer gender
ISO country code
Identity documents to attach or replace (see DocumentInput)
Proof-of-funds / source-of-wealth fields. Use allowed field values from Proof of funds options in the Customers guides.