Skip to main content
GET
Get card session

Authorizations

Authorization
string
header
required

Bearer authentication: send your API key, agent key, or OAuth access token as Authorization: Bearer <credential>.

Headers

X-Instance-ID
string | null

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Maximum string length: 1024

Path Parameters

sessionId
string
required
Pattern: ^csn_[0-9a-f]{32}$

Response

Successful Response

sessionId
string
required
cardId
string
required
cardSource
enum<string>
required

natural_issued: a Natural-issued card. external: a card the user added on the dashboard.

Available options:
natural_issued,
external
status
enum<string>
required

pending_approval: waiting for the user; keep polling. approved: claim it now. declined: the user said no. claimed: already collected. expired: open a new session.

Available options:
pending_approval,
approved,
declined,
claimed,
expired
allowedHosts
string[]
required
claimExpiresAt
string
required

A pending session must be approved, and an approved one claimed, before this.

Maximum string length: 64
claimedAt
string | null
required
Maximum string length: 64
credentialExpiresAt
string | null
required

When the claimed proxy login stops working.

Maximum string length: 64
createdAt
string
required
Maximum string length: 64