Self-serve ecosystem client onboarding (org + merchant + profile)
Self-serve onboarding: creates the identity-provider organization, the merchant with its settlement account and the public profile in one call.
/v1/clientsSelf-serve onboarding: creates the identity-provider organization, the merchant with its settlement account and the public profile in one call. Requires clients:onboard and a consumer token from the identity provider — an API key or staff session is refused consumer_token_required (403). Calling it again from the same subject returns the existing client with 200 instead of 201, so a retried signup does not make a second shop. Refuses invalid_request (400), and org_provisioning_unavailable (503) when the identity provider cannot be reached, which is worth retrying.
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/clients" \ -H "Content-Type: application/json" \ -d '{ "display_name": "string" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea", "org_alias": "string", "display_name": "string", "category": "string", "description": "string", "logo_url": "string", "commission_bps": 0, "status": "pending", "approved_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z"}The clients the caller may manage
A consumer gets the clients its organization memberships cover, which is how a founder finds their own client after onboarding.
What this client sold, and what it kept
The client's own trading history: a summary (sales, gross, fees, marketplace commission, refunded and net, plus subscriber count) followed by a page of individual sales, newest first by created_at,...