Skip to Content

Claim Link

Claim a link to start the account connection flow. Called by the client SDK.

Request

POST /link/claim

Body

FieldTypeRequiredDescription
claim_codestringYesThe claim code from the link

Response

200 OK

{ "session_id": "session_xyz789", "client_token": "ct_...", "ws_url": "wss://sessions.passage.dev/sessions/session_xyz789/ws" }

Notes

  • This is a public endpoint — no API key required
  • Creates a new session and starts the provider automation
  • If the link previously failed, claiming again creates a fresh session
  • Links that completed successfully cannot be re-claimed
Last updated on