POST /verify/sessions/{id}:cancel

Cancel an open session

Bearer API key or staff session operation cancelVerifySession

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	—

Request

This endpoint has no request body.

curl -X POST "$MONICHEK_API/verify/sessions/{id}:cancel" \
  -H "Authorization: Bearer $MONICHEK_API_KEY"

const res = await fetch(`${MONICHEK_API}/verify/sessions/{id}:cancel`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${MONICHEK_API_KEY}`,
  },
});

const data = await res.json();

import os
import requests

res = requests.post(
    f"{os.environ['MONICHEK_API']}/verify/sessions/{id}:cancel",
    headers={"Authorization": f"Bearer {os.environ['MONICHEK_API_KEY']}"},
)
print(res.json())

$ch = curl_init(getenv('MONICHEK_API') . '/verify/sessions/{id}:cancel');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('MONICHEK_API_KEY'),
    ],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Replace {id} with the resource id.

Responses

200 OK cancelled session application/json

{
  "object": "verify_session",
  "session_id": "vs_01M3R...",
  "status": "cancelled"
}

Error responses

Status	Meaning	Body
404	Not Found	RFC 9457 problem
409	Conflict	RFC 9457 problem

Errors use the RFC 9457 problem format with a stable code.