Skip to main content
POST
/
v1
/
sessions
/
{id}
/
cancel
Cancel a session
curl --request POST \
  --url http://127.0.0.1:8787/v1/sessions/{id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "data": null,
  "error": {
    "code": "NOT_FOUND",
    "message": "Session not found.",
    "hint": "The session with the given ID was not found.",
    "docs": "https://kayle.id/docs/api/sessions#cancel-by-id"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The ID of the verification session to cancel (e.g. vs_...).

Pattern: ^vs_[A-Za-z0-9]{64}$

Response

Session cancelled.