Skip to Content
Apex Settlement

Platforms

Serve your own customers as End Customers, open and onboard them over the API, and act for each of them with one header.

A Platform is a business Customer that sends payments for its own customers. Each of them is an End Customer: it has its contract with you, yet passes due diligence at every Provider it is routed through, and holds its own balance. Your system opens End Customers, runs their onboarding, and moves their money, all with your own API keys.

Becoming a Platform

An active business account becomes a Platform when we turn it on for you; contact your account manager. GET /v1/customer then answers "kind": "platform". A direct Customer reads direct, and an End Customer reads end_customer.

Your API keys can be given two permissions that matter here:

PermissionWhat it allows
customer:end_customers:manageOpen, suspend and reactivate End Customers.
customer:profile:writeRun an End Customer's onboarding: profile, documents, terms and submission.

Reading End Customers needs customer:read.

Open an End Customer

POST /v1/end-customers opens one. It requires an Idempotency-Key, like POST /v1/payouts. See Idempotency.

Prop

Type

curl -X POST "$APEX_BASE_URL/v1/end-customers" \
  -H "Authorization: Bearer $APEX_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "type": "business",
    "legal_name": "Harbor Crafts LLC",
    "email": "ops@harborcrafts.example.com",
    "country": "US"
  }'
201 Created
{
  "id": "a1f3c5e7-2b4d-4f68-8a9c-0e1d2c3b4a59",
  "type": "business",
  "legal_name": "Harbor Crafts LLC",
  "email": "ops@harborcrafts.example.com",
  "country": "US",
  "state": "profile_pending",
  "standing": "onboarding",
  "providers": [],
  "created_at": "2026-11-12T09:00:00Z",
  "updated_at": "2026-11-12T09:00:00Z"
}

Without invite_email, your system does every step by API. With it, a person of the End Customer can also sign in to the Customer panel and see only its own account. Both ways work side by side.

Inviting people needs a person

invite_email and POST /v1/end-customers/{id}/invite are refused for an API key with people_only (403). A person of your Platform invites from the Customer panel. An End Customer can be invited once: after it has anyone, the invite answers end_customer_has_people (409), and its own people invite the rest.

List, read, suspend

CallWhat it does
GET /v1/end-customersYour End Customers, newest first. Filters: state, q (part of the legal name or email), limit (default 50, at most 500) and offset.
GET /v1/end-customers/{id}One End Customer, with providers: its application at each Provider (submitted, info_required, approved, rejected or terminated), and has_people.
POST /v1/end-customers/{id}/suspendStop it, with a reason. It becomes read-only; Payouts already on their way finish.
POST /v1/end-customers/{id}/reactivateLift a suspension you made.

suspended_by says who suspended it: platform (you) or operator (our compliance team). You can lift only your own suspension; ours answers suspended_by_operator (403). suspended_reason is shown only for your own.

A caller whose account is not a Platform gets not_a_platform (403) on these routes. Send them without the Apex-End-Customer header: they act on your Platform, not on an End Customer.

Act for an End Customer

Add the header Apex-End-Customer with the End Customer's id to any other /v1 call. The call then works exactly as if the End Customer made it: its balances, its Beneficiaries, its quotes and Payouts. Your key's permissions stay the same.

curl "$APEX_BASE_URL/v1/balances" \
  -H "Authorization: Bearer $APEX_API_KEY" \
  -H "Apex-End-Customer: a1f3c5e7-2b4d-4f68-8a9c-0e1d2c3b4a59"
RoutesWith the header
/v1/customer, /v1/balances, /v1/deposit-instructions, /v1/beneficiaries*, /v1/quotes, /v1/payouts*, /v1/receiving*, /v1/incoming-payouts*, /v1/onboarding, /v1/profile*, /v1/documents*, /v1/termsWork for the End Customer.
/v1/webhooks*, /v1/api-keys*Refused with not_for_end_customers (403). Webhook endpoints and keys belong to the Platform.
/v1/team*Refused with not_while_acting (403).
/v1/end-customers*Refused: they act on the Platform. Send them without the header.
/v1/auth/*, /v1/signup/*The header is ignored.

If the header names an id that is not one of your End Customers, or your account is not a Platform, the call answers end_customer_not_found (404). The answer never tells whether such a Customer exists.

The End Customer's own standing applies: while it is onboarding, only the onboarding routes work for it (see Onboarding); while it is suspended, it can only read. If your Platform is suspended, every End Customer is read-only too.

Idempotency-Key values are kept per End Customer: the same key sent for two End Customers creates two resources.

Onboard an End Customer

An End Customer passes the same KYC or KYB as any Customer, with the same calls, made with its header. See Onboarding. The differences:

  • It accepts only the terms of the Providers it will be sent to. GET /v1/terms lists them.
  • It has no contract step with us: its path is profile_pending, profile_review, provider_onboarding, then active.
  • When our compliance team approves its profile, it is submitted automatically to every Provider that has approved your Platform.
  • It becomes active as soon as the first of those Providers approves it.

There is no webhook for an End Customer's onboarding. Read GET /v1/end-customers/{id} (its state and providers) or GET /v1/onboarding with its header to follow it.

Money

Each End Customer has its own balances, its own deposit instructions, its own Beneficiaries and its own Payouts. Nothing moves between your Platform's balance and an End Customer's. To fund an End Customer, deposit with the instructions GET /v1/deposit-instructions answers under its header.

An End Customer's quotes carry the fees agreed for it, or the Platform's when none were agreed separately.

Approvals

An End Customer's own approval rules apply when it has any, otherwise your Platform's. A held Payout of an End Customer can be approved in the Customer panel by any person of the End Customer or of your Platform who holds the approve permission. As for every Payout, the person who started it cannot approve it, and API keys never approve. See Send a payout.

Webhooks

Your Platform's webhook endpoints receive the events of all your End Customers. Such an event carries end_customer_id at the top level of the envelope:

{
  "id": "1b6c9e2f-7a3d-5c48-8e1f-2d4a6b8c0e13",
  "type": "payout.updated",
  "created_at": "2026-11-12T10:02:05Z",
  "end_customer_id": "a1f3c5e7-2b4d-4f68-8a9c-0e1d2c3b4a59",
  "data": { "id": "f0e1d2c3-b4a5-4968-8776-655443322110", "state": "completed" }
}

data is the full resource, shortened here. An event about your Platform itself has no end_customer_id. See Webhooks.

Errors

CodeStatusCause
not_a_platform403Your account is not a Platform, or you sent Apex-End-Customer to an /v1/end-customers route.
end_customer_not_found404The id is not one of your End Customers.
not_for_end_customers403Webhooks and API keys are refused for an End Customer.
not_while_acting403Team routes are refused while acting for an End Customer.
people_only403An invite was sent with an API key.
end_customer_has_people409The End Customer already has people; they invite the rest.
suspended_by_operator403We suspended this End Customer; only we can lift it.
country_not_accepted422We do not accept Customers from this country.
customer_suspended403The End Customer, or your Platform, is suspended: reads only.
customer_not_active403The End Customer is still onboarding, or was rejected.

Next steps

On this page