Magic links

​

What is a magic link?

​

Envelope vs config

​

Lifecycle

• Create — POST /partner/links
• Get — GET /partner/links/{linkId}
• List activity — GET /partner/links/{linkId}/activity
• Revoke — POST /partner/links/{linkId}/revoke

​

Response shape

{
  "success": true,
  "data": {
    "linkId": "link_acme_a1b2c3d4e5f6",
    "referenceId": "user-12345",
    "status": "created",
    "url": "https://<flow-host>/link_acme_a1b2c3d4e5f6",
    "token": "550e8400-e29b-41d4-a716-446655440000",
    "expiresAt": "2026-07-23T16:00:00.000Z",
    "createdAt": "2026-07-23T15:00:00.000Z"
  }
}

​

Delivery channels

• Redirect or deep link in your app
• Email / SMS / push
• Native WebView — tune splash/agreement with presentation (see Embed & WebView)

​

Best practices

• Reuse the same referenceId for the same person
• Keep TTLs short enough for your channel (default is typically 60 minutes)
• Revoke links that should no longer be usable
• Prefer webhooks over polling for open/complete signals

​

Next steps