Submit the Compliance Profile
customer:profile:writeSends the profile to Compliance for review. It must be complete, its address must be in the Customer's country, every document GET /v1/onboarding lists must be uploaded and the terms of GET /v1/terms accepted. The answer is the onboarding status; Compliance's decision moves it on.
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.
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 POST 'http://localhost:3480/v1/profile/submit'{ "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"}