Get a connection session

Poll session status until authorized, completed, expired, or revoked.

GET /v1/connection-sessions/{session_id}

Get a connection session

cURL

curl --request GET \
  --url https://api.swapnice.com/v1/connection-sessions/{session_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "app_id": "<string>",
  "customer_id": "<string>",
  "status": "created",
  "requested_purposes": [
    "account_linking"
  ],
  "expires_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "consent_receipt_id": "<string>",
  "swapnice_user_id": "<string>"
}

Poll session status until authorized, completed, expired, or revoked.

Statuses: created, authorized, completed, expired, revoked.

Authorizations

Authorization · string · header · required

OAuth 2.1 authorization code with PKCE. Implicit and password flows are unsupported.

Path Parameters

session_id · string · required

Response

200

application/json

Connection session state.

id · string · required

app_id · string · required

customer_id · string · required

status · enum<string> · required

Available options: created, authorized, completed, expired, revoked

requested_purposes · enum<string>[] · required

Available options: account_linking, personalization, analytics, support, event_enrichment, profile_resolution, measurement

expires_at · string<date-time> · required

created_at · string<date-time> · required

consent_receipt_id · string | null

swapnice_user_id · string | null