Skip to Content
Apex Settlement
Onboarding

Upload a Compliance Document

Required permissioncustomer:profile:write
POST
/v1/documents

Uploads one file of evidence for the Compliance Profile as multipart/form-data: file, kind, subject_kind and, for a beneficial owner or a control person, subject_ref, the person's name exactly as the profile spells it. PDF, JPEG or PNG, judged from the bytes, at most 10 MB; a Customer holds at most 200 versions and 200 MB. A new file of the same kind about the same subject becomes the next version and the older one stays. GET /v1/onboarding lists the documents a submission still needs. Refused once the profile is submitted, unless Compliance sends it back.

Requires the customer:profile:write permission. A Platform may call it for one of its End Customers with Apex-End-Customer.

Authorization

ApiKey
headerAuthorizationBearer <API key>

A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.

Header Parameters

Apex-End-Customer?string

A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers end_customer_not_found.

Formatuuid

Request Body

multipart/form-data
  1. body
file*file

The file: PDF, JPEG or PNG, at most 10 MB.

Formatbinary
kind*string

What the document is.

Value in"certificate_of_incorporation""articles_or_by_laws""certificate_of_good_standing""operating_agreement""proof_of_address""ownership_structure""government_id""other"
subject_kind*string

Whom it is about.

Value in"business""ubo""control_person""individual"
subject_ref?string

For ubo and control_person, the person's name as the profile spells it.

Response Body

Created

application/json
  1. response
current*boolean

current marks the version in force for its kind and subject.

file_name*string
id*string
kind*string
Value in"certificate_of_incorporation""articles_or_by_laws""certificate_of_good_standing""operating_agreement""proof_of_address""ownership_structure""government_id""other"
mime*string
Value in"application/pdf""image/jpeg""image/png"
sha256*string
size_bytes*integer
subject_kind*string
Value in"business""ubo""control_person""individual"
subject_ref?string
superseded_at?string
Formatdate-time
uploaded_at*string
Formatdate-time
version*integer
Example Request
curl -X POST 'http://localhost:3480/v1/documents' \  -F 'file=string' \  -F 'kind=certificate_of_incorporation' \  -F 'subject_kind=business'
Example Response
{  "current": true,  "file_name": "government_id.pdf",  "id": "9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a",  "kind": "government_id",  "mime": "application/pdf",  "sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",  "size_bytes": 482113,  "subject_kind": "individual",  "subject_ref": "string",  "superseded_at": "2019-08-24T14:15:22Z",  "uploaded_at": "2026-11-10T16:30:00Z",  "version": 1}