API reference OpenAPI 3.1
POST /verify/sessions/{id}:acknowledge

Record consent acknowledgment; parks in liveness (or address/completed per config)

Bearer API key or staff session operation acknowledgeVerifySession

Parameters

NameInTypeRequiredDescription
id path string Yes —

Request

This endpoint has no request body.

curl -X POST "$MONICHEK_API/verify/sessions/{id}:acknowledge" \
  -H "Authorization: Bearer $MONICHEK_API_KEY"
const res = await fetch(`${MONICHEK_API}/verify/sessions/{id}:acknowledge`, {
  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}:acknowledge",
    headers={"Authorization": f"Bearer {os.environ['MONICHEK_API_KEY']}"},
)
print(res.json())
$ch = curl_init(getenv('MONICHEK_API') . '/verify/sessions/{id}:acknowledge');
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 liveness session (next_step liveness), address session when liveness is off but config.address_required is true, or completed session when both legs are off application/json
{
  "object": "verify_session",
  "session_id": "vs_01M3R...",
  "status": "liveness",
  "notice_version": "v1",
  "next_step": "liveness"
}

Error responses

StatusMeaningBody
401 Unauthorized RFC 9457 problem
409 Conflict RFC 9457 problem

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