Download a Compliance Document
customer:profile:writeThe file itself, as an attachment of its type (application/pdf, image/jpeg or image/png). Every read is recorded.
Requires the customer:profile:write permission. A Platform may call it for one of its End Customers with Apex-End-Customer.
ApiKeyAuthorizationBearer <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.
id*stringThe document's id.
uuidApex-End-Customer?stringA 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.
uuidOK
response?filebinarycurl -X GET 'http://localhost:3480/v1/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/content'"string"Upload a Compliance Document POST
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.
Get the onboarding status GET
Where the Customer stands on its way in and what it still owes.