Skip to Content
Passage ConnectAPI ReferenceCreate Link

Create Link

Create a new link intent for account connection.

Request

POST /v1/links

Headers

HeaderValue
AuthorizationBearer YOUR_API_KEY
Content-Typeapplication/json

Body

FieldTypeRequiredDescription
providerstringYesProvider identifier (e.g., tmobile, att, verizon)
webhook_urlstringNoURL to receive completion webhook

Response

200 OK

{ "id": "link_abc123", "claim_code": "xxxx-xxxx-xxxx", "provider": "tmobile", "status": "created", "created_at": "2025-01-01T00:00:00Z" }

Notes

  • Creates a link record only — no session is spawned until the link is claimed
  • The claim_code is passed to the client SDK to initiate the flow
Last updated on