Skip to Content
Apex Settlement
Onboarding

Get the onboarding status

Required permissioncustomer:read
GET
/v1/onboarding

Where 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.

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

Response Body

OK

application/json
  1. 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?string

note 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
Value in"onboarding""active""suspended""closed"
state*string
Value in"profile_pending""profile_review""contract_pending""provider_onboarding""active""suspended""rejected"
terms_accepted*boolean
type*string
Value in"individual""business"
Example Request
curl -X GET 'http://localhost:3480/v1/onboarding'
Example Response
{  "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"}