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
codestringYesThe claim code (e.g., clm_xxx)

Response

200 OK

{ "linkId": "link_abc123", "sessionId": "session_xyz789", "clientToken": "ct_...", "websocketUrl": "wss://sessions.services.getpassage.ai/sessions/session_xyz789/ws", "expiresAt": 1704081600000 }

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
  • Expired links return 410 Gone
Last updated on