Pick the agent's number

POST/v1/connections/{code}/match

The user picks the number the agent shows beside its link out of the three the request offers. The right one opens the request; a wrong one denies it, since the link may not be the user's agent's.

Path parameters

codestringRequired

Headers

Content-Typeapplication/jsonRequired
idempotency-keystringRequired
Idempotency-KeystringRequired: 1 to 255 characters. A retry with the same key returns the first answer.

Request body

application/json

numberintegerRequired

Responses

200Matched
401Not signed in
404No open request with this code
409Not the agent's number (number-mismatch); the request is denied

200 response

matchedbooleanRequired: One of true

curl -X POST https://api.keelson.finance/v1/connections/{code}/match \
  -H 'content-type: application/json' \
  -H 'idempotency-key: <idempotency-key>' \
  -H "idempotency-key: $(uuidgen)" \
  --data '{"number":0}'

const res = await fetch("https://api.keelson.finance/v1/connections/{code}/match", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "idempotency-key": "<idempotency-key>",
    "idempotency-key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "number": 0
  }),
});
const data = await res.json();

Response · shape from the schema

{
  "matched": true
}