Skip to main content
POST
Create connected account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
email
string
required
organization_name
string
required
country
string<CountryCode> | null
Example:

"US"

metadata
any
mode
enum<string> | null

Onboarding mode for connected accounts

Available options:
express,
full
redirect_url
string | null

Response

Connected account created

The created account (same fields as ConnectedAccount) plus its onboarding link.

connection_type
enum<string>
required

Type of connection between platform and connected account

Available options:
standard,
express
created_at
string<date-time>
required
id
string<MeteroidId>
required
Example:

"cacc_7n42DGM5Tflk9n8mt7Fhc7"

onboarding_mode
enum<string>
required

Onboarding mode for connected accounts

Available options:
express,
full
platform_organization_id
string<MeteroidId>
required
Example:

"org_7n42DGM5Tflk9n8mt7Fhc7"

status
enum<string>
required

Status of a connected account

Available options:
pending,
active,
revoked,
suspended

Result of creating an onboarding link

connected_organization_id
string<MeteroidId> | null

For express accounts in pending status, this may be None until onboarding completes

Example:

"org_7n42DGM5Tflk9n8mt7Fhc7"

connected_tenant_id
string<MeteroidId> | null

Tenant ID for express accounts (single-tenant). None for standard accounts (use tenant header).

Example:

"ten_7n42DGM5Tflk9n8mt7Fhc7"

metadata
any
onboarding_completed_at
string<date-time> | null
pending_country
string<CountryCode> | null

Country code for the organization to be created (express flow only)

Example:

"US"

pending_email
string | null

Email of the user being invited (express flow only)

pending_organization_name
string | null

Name of the organization to be created (express flow only)

platform_customer_id
string<MeteroidId> | null
Example:

"cus_7n42DGM5Tflk9n8mt7Fhc7"

revoked_at
string<date-time> | null