v2.accounts

Retrieve the API onboarding state of an account (platform key)

Platform keys only. The state of the API onboarding of a connected account created by this platform: the last completed step, the state (in_progress, incomplete, done, failed), the next_step a repeated POST /accounts would run, last_error (a code and the body param, never a payload) and livemode. Available as soon as the store step completed — before the seller is a member — because the onboarding row itself proves the platform owns it. A sandbox key reads both its simulated onboardings (livemode: false, email: null) and the real ones of the platform; a live key never sees a sandbox onboarding (404).

get/accounts/{id}/onboarding

Request

  • Base URL: https://api.cooud.com/v2
  • URL: https://api.cooud.com/v2/accounts/{id}/onboarding
  • Auth: HTTP bearer

Path parameters

idstring required

Connected account id (cooud_acct_<ULID> — the seller's store).

Headers

Cooud-Compat-Datestring date required

Required per-request compat-date. Format: ISO calendar date YYYY-MM-DD. Merchants pinned to an older date have their request and response transformed by every gate whose appliesAfter is strictly greater than this date.

Response

The onboarding state.

object'account_onboarding' required
idstring required

cooud_onb_<ULID>: this onboarding, readable at GET /account_onboardings/{id}. Present on every 202 — also before the store exists, when account is still null.

accountstring nullable required

cooud_acct_<store ULID> once the store step completed; null before.

emailstring nullable required

On the 202 of POST /accounts, the e-mail of the request; on GET /account_onboardings?email=, the e-mail looked up (trimmed, lower case), for a simulated onboarding too; on GET /account_onboardings/{id} and GET /accounts/{id}/onboarding, the store owner of record — null when the store has no owner yet, and always null for a simulated sandbox onboarding (only the e-mail hash is kept).

business_type'individual' | 'company' required
step'created' | 'user' | 'store' | 'stripe_account' | 'kyc' | 'bank' | 'documents' | 'terms' | 'membership' | 'done' required

The last completed step.

state'in_progress' | 'incomplete' | 'done' | 'failed' required

in_progress (a request holds it), incomplete (repeat the POST to resume), done, failed (the seller belongs to another platform).

next_step'user' | 'store' | 'stripe_account' | 'kyc' | 'bank' | 'documents' | 'terms' | 'membership' | 'done' nullable required

The step a repeated POST /accounts runs next; null when done.

livemodeboolean required

false when the onboarding was simulated under a sandbox key.

metadataobject required
createdinteger required

Unix epoch seconds.

request_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.