Skip to main content
POST
Create a connected account

Authorizations

Authorization
string
header
required

API key: Authorization: Bearer sk_test_... or sk_live_....

Headers

Invoice-Version
string

Pin a dated API release (Stripe-style). Omit to use the current version. An unknown value returns 400 request.invalid_version. Echoed back on every response.

Example:

"2026-07-10"

Invoice-Account
string

Connect: act on behalf of one of your connected accounts (its acct_…/org_… id). Omit to act as your own organization. Not honored on /v1/api_keys.

Example:

"org_2P9connectedacct"

Idempotency-Key
string

Safely retry any POST. The first response is stored for 24h and replayed byte-for-byte for identical retries (the replay adds an idempotent-replayed: true header). Reusing the key with a different body is 409 idempotency.key_reuse; an in-flight duplicate is 409 idempotency.key_processing. This makes retrying a 502/429 safe — no duplicate stamp.

Example:

"a1b2c3d4-e5f6-4789-8abc-1234567890ab"

Body

application/json
name
string
required

Display name of the connected account (e.g. the end-customer / taxpayer business).

Required string length: 1 - 200
metadata
object

Integrator-owned key-value map (≤50 keys), stored and echoed back verbatim.

Response

Default Response

object
enum<string>
required

Always "account".

Available options:
account
id
string
required

Connected-account id, e.g. "org_2P9K3sample".

name
string
required

Display name of the connected account.

parent
string
required

The platform org that owns this connected account.

disabled
boolean
required

True once the account has been disabled/offboarded (acting as it is rejected).

metadata
object
required

Integrator-owned key-value map echoed back.

created_at
string
required

Creation timestamp, ISO-8601 UTC.