Upload a customer file

Upload a supporting document for a customer: a KYB document, a
control-person identity document, or payment documentation. See
FileType for the full list. Payment documents are single-use;
upload a new document per payout.

file_type and control_person_id are multipart form fields (a
file_type query parameter is still accepted for backward compatibility).
On a BUSINESS customer, control_person_id is required when file_type
is a person-level document (IDENTITY_DOCUMENT, IDENTITY_DOCUMENT_BACK or
PROOF_OF_ADDRESS) so the document is attached to the specific control
person it belongs to, and must be omitted for all other file types. It must
reference a control person that exists on this customer. On an INDIVIDUAL
customer, documents belong to the customer and control_person_id must be
omitted. SELFIE and SOURCE_OF_FUNDS are accepted only for
INDIVIDUAL customers.

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

The document to upload

string
enum
required

Sent as a form field (a query parameter is also accepted).

string

Public id (cpn_...) of the control person this document belongs
to. Required on a BUSINESS customer for IDENTITY_DOCUMENT,
IDENTITY_DOCUMENT_BACK and PROOF_OF_ADDRESS; must be omitted for
all other file types and for INDIVIDUAL customers.

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

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