Agentcard

Submit a customer's one-time code

Completes the ceremony connect started: verifies the code, records the customer's consent, and stores the connection. Returns connected on success, after which payments for this handle no longer need the customer present.

The code reaches you however your channel works — typically the customer replies with it in the thread. Codes are single-use and short-lived; if one has expired, call connect again for a fresh connect_id.

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

Request

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

Path parameters

handlestring required

Customer phone (E.164) or email

Request body

connect_idstring required

The id returned by connect.

codestring required

The one-time code the customer received.

Example request

{
  "connect_id": "cs_01HZY8",
  "code": "482913"
}

Response

Connection established

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.