Claim Link

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

Request


POST /link/claim

Body

Field	Type	Required	Description
`code`	string	Yes	The claim code (e.g., `clm_xxx`)

Response

200 OK


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

400 Bad Request

Missing or empty code field.

404 Not Found

Invalid claim code — no matching link exists.

409 Conflict

Link has already been used (completed and non-reusable), or a concurrent claim is in progress.

410 Gone

Link has expired.

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 (unless the link is reusable)
Expired links return 410 Gone