Get the onboarding status
customer:readWhere the Customer stands on its way in and what it still owes. state is profile_pending while the profile is a draft, profile_review once it is submitted, contract_pending while the platform's terms wait for acceptance, provider_onboarding while the Providers decide, then active; or suspended or rejected. With it come the fields Compliance asked to change (requested_fields, note), the profile fields still missing, every document a submission needs and whether it is uploaded, whether the terms are accepted, and each Provider's decision.
Requires the customer:read 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.
Apex-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
application/json- response
documents*array<>documents are the Compliance Documents a submission needs and whether each is uploaded.
missing_fields*array<>missing_fields are the profile fields a submission would still find missing or malformed.
note?stringnote is what Compliance wrote when it sent the profile back.
providers*array<>providers are each Provider's decision on the Customer.
requested_fields*array<string>requested_fields are the profile fields Compliance asked to change.
standing*string"onboarding""active""suspended""closed"state*string"profile_pending""profile_review""contract_pending""provider_onboarding""active""suspended""rejected"terms_accepted*booleantype*string"individual""business"curl -X GET 'http://localhost:3480/v1/onboarding'{ "documents": [ { "kind": "government_id", "subject_kind": "individual", "uploaded": true }, { "kind": "proof_of_address", "subject_kind": "individual", "uploaded": false } ], "missing_fields": [ { "field": "individual.date_of_birth", "message": "required" } ], "note": "Please upload a proof of address dated within three months.", "providers": [ { "provider": "bvnk", "state": "approved" } ], "requested_fields": [ "individual.address.line1" ], "standing": "onboarding", "state": "profile_pending", "terms_accepted": false, "type": "individual"}Download a Compliance Document GET
The file itself, as an attachment of its type (`application/pdf`, `image/jpeg` or `image/png`).
Get the Compliance Profile GET
The Customer's Compliance Profile: the draft while it is `profile_pending`, else its last submission, with the fields Compliance asked to change.