API reference Connections
Read a request by its user code
GET/v1/connections/{code}
What the agent asks for, for the approval page. Limited to 20 reads a minute per user, so codes cannot be guessed.
Path parameters
codestringRequired
Responses
- 200The request
- 401Not signed in
- 404No such request for this user
- 429Too many reads
200 response
codestringRequiredkindstringRequiredconnect: standing limits.once: one cart its mandate does not allow.change: new limits that replaceparent, whose hold is released.One ofconnectoncechangestatestringRequired- One of
PENDINGAPPROVEDDENIEDEXPIRED namestringRequiredreasonstringRequiredagentobjectRequiredlimitsobjectRequiredparentobjectRequiredmandateIdstringRequiredcartobjectRequired- For
once: the cart the agent tried, as it saw it. checksarray of objectRequired- For
once: each mandate field against the cart; the failing ones are why it is paused.askAbovefails when the cart is above the user's ask-me amount. matchobjectRequired- When the user must pick the agent's number before approving: three numbers, one the agent shows. Null when the request needs no match.
expiresAtstringRequiredcreatedAtstringRequired