Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

A Platform Connect secret key (sk_…) sent as Authorization: Bearer <key>.

Headers

Idempotency-Key
string
required

A unique key that makes a retry return the original result.

Required string length: 1 - 255

Body

application/json
redirect_uri
string<uri>
required

Exact HTTPS callback registered for the Platform.

Pattern: ^https://[^/?#]+/connect/callback$
state
string
required

Opaque value your callback must verify against the value stored before redirecting.

Required string length: 1 - 512
code_challenge
string
required

Base64url-encoded SHA-256 digest of the PKCE verifier, without padding.

Required string length: 43
code_challenge_method
enum<string>
required
Available options:
S256
permissions
string[]
required

Permissions the Platform asks the Account holder to grant.

Required array length: 1 - 50 elements

Response

The authorization request and browser URL.

id
string
required
Pattern: ^aauth_[0-9A-Za-z]{24}$
object
enum<string>
required
Available options:
account_authorization
status
enum<string>
required
Available options:
pending
channel
enum<string>
required
Available options:
platform_redirect
livemode
boolean
required
permissions
string[]
required
authorization_url
string<uri>
required

Browser URL to open for the Account holder.

created_at
string<date-time>
required
expires_at
string<date-time>
required