v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Create an Account Session

Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.

post/v1/account_sessions

Response

Successful response.

accountstring required

The ID of the account the AccountSession was created for

client_secretstring required

The client secret of this AccountSession. Used on the client to set up secure access to the given account.

The client secret can be used to provide access to account from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.

Refer to our docs to setup Connect embedded components and learn about how client_secret should be handled.

expires_atinteger required

The timestamp at which this AccountSession will expire.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'account_session' required

String representing the object's type. Objects of the same type share the same value.