API Reference

Update a customer

patch
https://api.checker.finance/v1/payments/customers/

Partially update a customer; only provided fields change. Onboarded customers are updated in every corridor they are onboarded in. On failure nothing is saved: 400 CUSTOMER_INACTIVE if the customer is not active, otherwise 422 PROVIDER_ERROR or 503 PROVIDER_UNAVAILABLE (safe to retry).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

All fields optional (PATCH semantics); omitted top-level fields are unchanged. When address is present it is a full-object replace (line1, city, postal_code, country required; omitted line2/state cleared). country must match the customer's immutable country.

string

Customer legal full name

string
string

E.164 format (e.g. +14155551234)

address
object
kyb
object

All KYB fields optional on PATCH; omitted fields are unchanged

kyc
object

All KYC fields optional on PATCH; omitted fields are unchanged. INDIVIDUAL only.

Headers
string
required

Idempotency key required on all write requests. Replaying the same key with the same body returns the original response.

string
required

Your API key

string
required

Request timestamp (ISO 8601 UTC), included in the signature payload

string
required

Unique request nonce (e.g. UUID)

string
required

HMAC-SHA256 hex digest of {METHOD}\n{path}\n{query}\n{X-Timestamp}\n{body}, signed with your API secret. Path excludes the query string; use an empty string for query/body when absent.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?