Agentcard

Connect a customer handle

Starts connecting a customer (by phone/email) so an agent can pay on their behalf. Linq drives the OTP + consent ceremony through the messaging channel; this returns pending and a connection.created webhook fires once the customer completes it.

post/v3/payments/handles/{handle}/connect

Request

  • Base URL: https://api.linqapp.com/api/partner
  • URL: https://api.linqapp.com/api/partner/v3/payments/handles/{handle}/connect
  • Auth: HTTP bearer

Path parameters

handlestring required

Customer phone (E.164) or email

Response

Connection ceremony started

handlestring
status'not_connected' | 'pending' | 'connected' | 'revoked'
connect_idstring

Returned only by connect, and only while the ceremony is pending. Nothing on our side persists it — it comes back from the provider and is required again to verify — so hold it until you submit the code.

Example response

{
  "handle": "+14155550123",
  "status": "connected",
  "connect_id": "cs_01HZY8"
}

Changes

No recorded changes to this operation across all 1 revision of this API.