Create Link
Create a new link intent for account connection.
Request
POST /v1/linksHeaders
| Header | Value |
|---|---|
Authorization | Bearer YOUR_API_KEY |
Content-Type | application/json |
Body
| Field | Type | Required | Description |
|---|---|---|---|
provider | string | Yes | Provider identifier (e.g., tmobile, att, verizon) |
webhook_url | string | No | URL 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_codeis passed to the client SDK to initiate the flow
Last updated on