После завершения внедрения браузера ваш сервер должен проверить результат с помощью ключа сайта API, прежде чем разрешить регистрацию, оформление заказа или любое защищенное действие.
Скрытое поле формы может называться checkify_token, но его значением будет request_id (идентификатор запроса) в формате Checkify.
В панели управления вашего бизнеса откройте Разработчик. и создайте ключ API для сайта, который вы интегрируете. Храните его только в переменных среды сервера — никогда не отправляйте его в браузер.
Вам не нужно вручную вызывать GET /v1/qr/pass/{PASS_ID}/start. Встроенный модуль Checkify JavaScript запускает сессию, получает request_id и автоматически записывает его в вашу форму.
Вашей серверной части достаточно выполнить лишь следующее:
Фронтенд SDK записывает Checkify request_id в скрытое поле формы после завершения пользователем верификации. Имя поля по умолчанию — checkify_token — это имя поля, а не отдельный тип токена. Значение поля отправляется на конечную точку проверки в качестве request_id.
В адресе страницы при передаче данных в мобильном приложении может возвращаться значение checkify_request_id. SDK считывает его при загрузке; ваш сервер по-прежнему проверяет то же значение request_id.
Отправьте POST-запрос из вашего фронтенда.
{
"email": "user@example.com",
"checkify_token": "56a57761-ff5b-42f0-9c97-6c13e223e017"
}
Проверьте запрос из вашей серверной части.
{
"request_id": "56a57761-ff5b-42f0-9c97-6c13e223e017",
"required_claims": ["human_verified"],
"required_fields": [],
"consume": true
}
Только ручная интеграция фронтенда
Разработчики бэкенда обычно не вызывают /start. Используйте этот раздел только при создании собственного фронтенда или тестировании без встраивания. Заключайте URL-адреса в кавычки в zsh/bash, чтобы знак вопроса (?) не рассматривался как шаблон.
Команда `pass start` работает только с зарегистрированного домена веб-сайта. Браузеры автоматически отправляют Origin; cURL этого не делает. Отправьте Origin (или X-Checkify-Site-Url) с именем хоста, указанным в разделе «Сайты» → «Разрешенные домены». Имя хоста должно совпадать точно — checkify.me и www.checkify.me — разные домены.
Наиболее распространенная проблема при тестировании
Если /start возвращает HTTP 403, ваш Pass ID может быть всё ещё действителен. Обычно это происходит из-за того, что запрашиваемый домен не указан в списке разрешенных доменов, или был зарегистрирован www.example.com, но использовался example.com (или наоборот).
Используйте выделенный тестовый сайт и пройдите тестирование в панели мониторинга Checkify для интеграционного тестирования. Ключи сайта API используют префикс csk_; отдельного формата тестового ключа нет. Не проводите тестирование на рабочей версии, пока не подтвердите как успешные, так и неудачные сценарии.
# Step A — start a session (replace PASS_ID and YOUR_REGISTERED_DOMAIN)
curl -sS \
-H "Accept: application/json" \
-H "Origin: https://YOUR_REGISTERED_DOMAIN" \
"https://checkify.me/v1/qr/pass/chk_live_YOUR_PASS_ID/start?request_type=human"
# Response includes request_id and qr_url — open qr_url and complete verification
# Step B — verify on your server (after the user completes verification)
curl -sS -X POST "https://checkify.me/v1/qr/results/verify" \
-H "Authorization: Bearer $CHECKIFY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"request_id": "PASTE_request_id_FROM_STEP_A",
"required_claims": ["human_verified"],
"consume": true
}'
Используйте ключ API вашего сайта только при вызове проверки. Завершите проверку в приложении перед вызовом проверки — в противном случае вы получите статус «ожидание».
Установите параметр required_claims в соответствии с требованиями к подтверждению, необходимым для вашего защищаемого действия. Названия утверждений должны совпадать с тем, что было одобрено Checkify для данной сессии проверки. Для проверки возраста используется age_over_{N} (например, age_over_18). Поддерживаются динамические пороговые значения от 10 до 110, если встраивание запрашивает соответствующий тип запроса.
| Вариант использования | Предложенные обязательные утверждения | Примечания |
|---|---|---|
| Замена бота / CAPTCHA | ["human_verified"] |
Подтверждает, что реальный пользователь завершил процесс Checkify. |
| Контент 13+ или продукция, ориентированная на молодежь | ["age_over_13"] |
Используйте, если ваш пропуск запрашивает возраст старше 13 лет. |
| Контент 16+ или региональные возрастные ограничения | ["age_over_16"] |
Используйте, если ваш пропуск запрашивает возраст старше 16 лет. |
| Электронные сигареты, алкоголь или касса для лиц старше 18 лет. | ["age_over_18"] |
Сопоставьте возрастной порог с вашим продуктом и рынком. |
| Товары, продажа которых ограничена для лиц старше 21 года (где это применимо). | ["age_over_21"] |
Используйте, если ваш пропуск запрашивает возраст старше 21 года. |
| Правила розничной торговли, требующие соответствия требованиям для лиц старше 25 лет или более строгих требований. | ["age_over_25"] |
Используйте, если ваш пропуск запрашивает возраст старше 25 лет. |
| Пользовательский возрастной порог | ["age_over_N"] |
Используйте age_over_N, где N — это значение от 10 до 110, соответствующее типу вашего запроса на встраивание. |
Тип запроса браузера должен совпадать с утверждением, которое вы проверяете на стороне сервера.
| тип запроса на встраивание | required_claims |
|---|---|
human | ["human_verified"] |
age_over_13 | ["age_over_13"] |
age_over_16 | ["age_over_16"] |
age_over_18 | ["age_over_18"] |
age_over_21 | ["age_over_21"] |
age_over_25 | ["age_over_25"] |
age_over_N | ["age_over_N"] (N = 10–110) |
Помимо required_claims вы можете требовать конкретные одобренные поля идентичности (например страну или возрастную группу), если интеграция их собрала. Передайте имена в required_fields — если их нет в одобренном результате, verify возвращает missing_required_fields с missing_fields в error.details.
Перед предоставлением доступа вызовите POST-запрос /v1/qr/results/verify, указав ключ API вашего сайта. Считайте ссылку на браузер (request_id или устаревший токен опроса) недоверенной до тех пор, пока Checkify не подтвердит результат.
POST https://checkify.me/v1/qr/results/verify
Authorization: Bearer YOUR_SITE_API_KEY
Content-Type: application/json
{
"request_id": "56a57761-ff5b-42f0-9c97-6c13e223e017",
"required_claims": ["human_verified"],
"consume": true
}
Вы также можете отправить
token
вместо
request_id.
Ключ API ограничен областью действия вашего сайта Checkify — в теле запроса не нужно отправлять site_id.
# checkify_token from your form POST is sent as request_id
curl -sS -X POST "https://checkify.me/v1/qr/results/verify" \
-H "Authorization: Bearer $CHECKIFY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"request_id": "56a57761-ff5b-42f0-9c97-6c13e223e017",
"required_claims": ["human_verified"],
"consume": true
}'
import express from "express";
const app = express();
app.use(express.json());
const CHECKIFY_API_KEY = process.env.CHECKIFY_API_KEY;
const CHECKIFY_BASE_URL = process.env.CHECKIFY_BASE_URL || "https://checkify.me";
async function verifyCheckifyResult(requestId, requiredClaims = ["human_verified"]) {
const controller = new AbortController();
const timeout = setTimeout(() => controller.abort(), 10000);
try {
const res = await fetch(`${CHECKIFY_BASE_URL}/v1/qr/results/verify`, {
method: "POST",
headers: {
Authorization: `Bearer ${CHECKIFY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
request_id: requestId,
required_claims: requiredClaims,
consume: true,
}),
signal: controller.signal,
});
let body = null;
try {
body = await res.json();
} catch {
body = null;
}
if (!res.ok) {
const details = body?.error?.details || {};
console.warn("Checkify verification failed", {
requestId,
code: body?.error?.code,
missingClaims: details.missing_claims,
missingFields: details.missing_fields,
reason: details.reason,
});
return {
allow: false,
reason: body?.error?.code || "verification_failed",
userMessage: "Verification could not be completed for this action.",
};
}
if (!body || body.status === "pending" || body.success === false) {
return {
allow: false,
reason: body?.status || "pending",
userMessage: "Verification could not be completed for this action.",
};
}
const approved = requiredClaims.every(
(claim) => body.approved_claims?.[claim] === true
);
return {
allow: approved,
reason: approved ? "approved" : "verification_failed",
userMessage: approved
? null
: "Verification could not be completed for this action.",
result: body,
};
} finally {
clearTimeout(timeout);
}
}
app.post("/signup", async (req, res) => {
const requestId = (req.body.checkify_token || "").trim();
if (!requestId) {
return res.status(403).json({ error: "Verification required" });
}
try {
const verdict = await verifyCheckifyResult(requestId);
if (!verdict.allow) {
return res.status(403).json({ error: verdict.userMessage });
}
return res.json({ ok: true });
} catch (err) {
console.error("Checkify verification unavailable", err);
return res.status(403).json({
error: "Verification is temporarily unavailable. Please try again.",
});
}
});
import { Checkify } from "@checkify/server";
const checkify = new Checkify({
apiKey: process.env.CHECKIFY_SITE_API_KEY,
});
app.post("/signup", async (req, res) => {
const requestId = String(req.body.checkify_token || "").trim();
if (!requestId) {
return res.status(403).json({ error: "Verification required" });
}
try {
const result = await checkify.verifyHuman({ requestId, consume: true });
if (!result.success || !result.approved) {
return res.status(403).json({
error: "Verification could not be completed for this action.",
});
}
return res.json({ ok: true });
} catch (err) {
console.error("Checkify verification failed", err);
return res.status(403).json({
error: "Verification is temporarily unavailable. Please try again.",
});
}
});
import os
import httpx
from fastapi import FastAPI, HTTPException
app = FastAPI()
CHECKIFY_API_KEY = os.environ["CHECKIFY_API_KEY"]
CHECKIFY_BASE_URL = os.getenv("CHECKIFY_BASE_URL", "https://checkify.me")
USER_MESSAGE = "Verification could not be completed for this action."
UNAVAILABLE = "Verification is temporarily unavailable. Please try again."
def verify_checkify_result(request_id: str, required_claims=None) -> dict:
required_claims = required_claims or ["human_verified"]
try:
response = httpx.post(
f"{CHECKIFY_BASE_URL}/v1/qr/results/verify",
headers={
"Authorization": f"Bearer {CHECKIFY_API_KEY}",
"Content-Type": "application/json",
},
json={
"request_id": request_id,
"required_claims": required_claims,
"consume": True,
},
timeout=10.0,
)
except httpx.RequestError as exc:
print("Checkify verification unavailable", exc)
return {"allow": False, "reason": "unavailable", "user_message": UNAVAILABLE}
try:
body = response.json()
except ValueError:
body = None
if response.status_code >= 400:
error = (body or {}).get("error") if isinstance(body, dict) else None
details = (error or {}).get("details", {})
print(
"Checkify verification failed",
{
"request_id": request_id,
"code": (error or {}).get("code"),
"missing_claims": details.get("missing_claims"),
"missing_fields": details.get("missing_fields"),
"reason": details.get("reason"),
},
)
return {
"allow": False,
"reason": (error or {}).get("code", "verification_failed"),
"user_message": USER_MESSAGE,
}
if not isinstance(body, dict) or body.get("status") == "pending" or body.get("success") is False:
return {"allow": False, "reason": "pending", "user_message": USER_MESSAGE}
approved = all((body.get("approved_claims") or {}).get(claim) is True for claim in required_claims)
return {
"allow": approved,
"reason": "approved" if approved else "verification_failed",
"user_message": None if approved else USER_MESSAGE,
"result": body,
}
@app.post("/signup")
def signup(email: str, checkify_token: str):
request_id = (checkify_token or "").strip()
if not request_id:
raise HTTPException(status_code=403, detail="Verification required")
verdict = verify_checkify_result(request_id)
if not verdict["allow"]:
raise HTTPException(status_code=403, detail=verdict["user_message"])
return {"ok": True}
<?php
$checkifyApiKey = getenv('CHECKIFY_API_KEY');
$baseUrl = getenv('CHECKIFY_BASE_URL') ?: 'https://checkify.me';
function verify_checkify_result(string $requestId, array $requiredClaims = ['human_verified']): array {
global $checkifyApiKey, $baseUrl;
$payload = json_encode([
'request_id' => $requestId,
'required_claims' => $requiredClaims,
'consume' => true,
]);
$ch = curl_init($baseUrl . '/v1/qr/results/verify');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $checkifyApiKey,
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => $payload,
CURLOPT_TIMEOUT => 10,
]);
$raw = curl_exec($ch);
$status = (int) curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($raw === false) {
error_log('Checkify verification unavailable');
return ['allow' => false, 'user_message' => 'Verification is temporarily unavailable. Please try again.'];
}
$body = json_decode($raw ?: 'null', true);
if ($status >= 400) {
$error = is_array($body) ? ($body['error'] ?? null) : null;
$details = is_array($error) ? ($error['details'] ?? []) : [];
error_log('Checkify verification failed: ' . json_encode([
'code' => is_array($error) ? ($error['code'] ?? null) : null,
'missing_claims' => $details['missing_claims'] ?? null,
]));
return ['allow' => false, 'user_message' => 'Verification could not be completed for this action.'];
}
if (!is_array($body) || ($body['status'] ?? '') === 'pending' || ($body['success'] ?? true) === false) {
return ['allow' => false, 'user_message' => 'Verification could not be completed for this action.'];
}
foreach ($requiredClaims as $claim) {
if (($body['approved_claims'][$claim] ?? false) !== true) {
return ['allow' => false, 'user_message' => 'Verification could not be completed for this action.'];
}
}
return ['allow' => true, 'result' => $body];
}
$requestId = trim($_POST['checkify_token'] ?? '');
if ($requestId === '') {
http_response_code(403);
echo json_encode(['error' => 'Verification required']);
exit;
}
$verdict = verify_checkify_result($requestId);
if (!$verdict['allow']) {
http_response_code(403);
echo json_encode(['error' => $verdict['user_message']]);
exit;
}
// continue protected action...
package main
import (
"bytes"
"encoding/json"
"fmt"
"net/http"
"os"
"strings"
"time"
)
type verifyResponse struct {
Success bool `json:"success"`
Status string `json:"status"`
Message string `json:"message"`
ApprovedClaims map[string]bool `json:"approved_claims"`
}
type errorResponse struct {
Error struct {
Code string `json:"code"`
Message string `json:"message"`
Details map[string]interface{} `json:"details"`
} `json:"error"`
}
func verifyCheckifyResult(requestID string, requiredClaims []string) (bool, string, error) {
apiKey := os.Getenv("CHECKIFY_API_KEY")
baseURL := os.Getenv("CHECKIFY_BASE_URL")
if baseURL == "" {
baseURL = "https://checkify.me"
}
payload, _ := json.Marshal(map[string]interface{}{
"request_id": requestID,
"required_claims": requiredClaims,
"consume": true,
})
req, err := http.NewRequest(http.MethodPost, baseURL+"/v1/qr/results/verify", bytes.NewReader(payload))
if err != nil {
return false, "", err
}
req.Header.Set("Authorization", "Bearer "+apiKey)
req.Header.Set("Content-Type", "application/json")
client := &http.Client{Timeout: 10 * time.Second}
res, err := client.Do(req)
if err != nil {
return false, "", err
}
defer res.Body.Close()
if res.StatusCode >= 400 {
var errBody errorResponse
_ = json.NewDecoder(res.Body).Decode(&errBody)
fmt.Printf("Checkify verification failed code=%s details=%v\n", errBody.Error.Code, errBody.Error.Details)
return false, "Verification could not be completed for this action.", nil
}
var body verifyResponse
if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
return false, "Verification could not be completed for this action.", nil
}
if body.Status == "pending" || !body.Success {
return false, "Verification could not be completed for this action.", nil
}
for _, claim := range requiredClaims {
if !body.ApprovedClaims[claim] {
return false, "Verification could not be completed for this action.", nil
}
}
return true, "", nil
}
func signupHandler(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodPost {
http.Error(w, "method not allowed", http.StatusMethodNotAllowed)
return
}
if err := r.ParseForm(); err != nil {
http.Error(w, "invalid form", http.StatusBadRequest)
return
}
requestID := strings.TrimSpace(r.FormValue("checkify_token"))
if requestID == "" {
http.Error(w, "Verification required", http.StatusForbidden)
return
}
allowed, message, err := verifyCheckifyResult(requestID, []string{"human_verified"})
if err != nil {
fmt.Println("Checkify verification unavailable", err)
http.Error(w, "Verification is temporarily unavailable. Please try again.", http.StatusForbidden)
return
}
if !allowed {
http.Error(w, message, http.StatusForbidden)
return
}
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte(`{"ok":true}`))
}
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;
var apiKey = Environment.GetEnvironmentVariable("CHECKIFY_API_KEY");
var baseUrl = Environment.GetEnvironmentVariable("CHECKIFY_BASE_URL") ?? "https://checkify.me";
async Task<(bool Allow, string UserMessage)> VerifyCheckifyAsync(string requestId)
{
using var client = new HttpClient { Timeout = TimeSpan.FromSeconds(10) };
using var req = new HttpRequestMessage(HttpMethod.Post, $"{baseUrl}/v1/qr/results/verify");
req.Headers.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
req.Content = new StringContent(JsonSerializer.Serialize(new
{
request_id = requestId,
required_claims = new[] { "human_verified" },
consume = true,
}), Encoding.UTF8, "application/json");
HttpResponseMessage res;
try
{
res = await client.SendAsync(req);
}
catch (Exception ex)
{
Console.Error.WriteLine($"Checkify verification unavailable: {ex.Message}");
return (false, "Verification is temporarily unavailable. Please try again.");
}
var raw = await res.Content.ReadAsStringAsync();
using var doc = JsonDocument.Parse(string.IsNullOrWhiteSpace(raw) ? "{}" : raw);
var root = doc.RootElement;
if (!res.IsSuccessStatusCode)
{
if (root.TryGetProperty("error", out var err) && err.TryGetProperty("details", out var details))
{
Console.WriteLine($"Checkify verification failed details={details}");
}
return (false, "Verification could not be completed for this action.");
}
if (root.TryGetProperty("status", out var status) && status.GetString() == "pending")
{
return (false, "Verification could not be completed for this action.");
}
if (root.TryGetProperty("approved_claims", out var claims)
&& claims.TryGetProperty("human_verified", out var human)
&& human.GetBoolean())
{
return (true, string.Empty);
}
return (false, "Verification could not be completed for this action.");
}
// In your signup endpoint:
// var requestId = form["checkify_token"];
// var (allow, message) = await VerifyCheckifyAsync(requestId);
// if (!allow) return Results.Forbid();
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.net.URI;
import java.net.http.*;
import java.time.Duration;
public class CheckifyVerify {
private static final String API_KEY = System.getenv("CHECKIFY_API_KEY");
private static final String BASE_URL =
System.getenv().getOrDefault("CHECKIFY_BASE_URL", "https://checkify.me");
private static final ObjectMapper MAPPER = new ObjectMapper();
static boolean verifyCheckifyResult(String requestId) {
String payload = "{\"request_id\":\"" + requestId + "\","
+ "\"required_claims\":[\"human_verified\"],\"consume\":true}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(BASE_URL + "/v1/qr/results/verify"))
.timeout(Duration.ofSeconds(10))
.header("Authorization", "Bearer " + API_KEY)
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(payload))
.build();
try {
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
JsonNode root = MAPPER.readTree(response.body() == null ? "{}" : response.body());
if (response.statusCode() >= 400) {
System.err.println("Checkify verification failed: " + root);
return false;
}
if ("pending".equals(root.path("status").asText()) || !root.path("success").asBoolean(false)) {
return false;
}
return root.path("approved_claims").path("human_verified").asBoolean(false);
} catch (Exception ex) {
System.err.println("Checkify verification unavailable: " + ex.getMessage());
return false;
}
}
}
Используйте consume: true для окончательных защищенных действий. — Оформление заказа, регистрация, сброс пароля, покупка с возрастным ограничением, доступ к защищенному контенту.
Используйте consume: false только для — тестирование, отладка или незавершенные проверки, результат которых необходимо будет подтвердить позже.
Для регулируемых или высокорискованных действий предпочтительнее использовать параметр consume: true, чтобы один и тот же результат проверки не мог быть использован для нескольких защищаемых решений.
Если ваш бэкэнд не может связаться с Checkify, не разрешайте оформление заказа с возрастными ограничениями, доступ к азартным играм, доступ к контенту для взрослых, покупку электронных сигарет или алкоголя, а также другие защищенные действия без подтвержденного результата на стороне сервера.
Используйте короткие тайм-ауты HTTP (например, 10 секунд). Повторяйте попытку один или два раза при временных ошибках 5xx или сетевых ошибках, затем откажите в доступе. Регистрируйте инциденты на стороне сервера и отображайте безопасные для пользователя сообщения. Не раскрывайте клиентам подробности внутренних ошибок Checkify.
try {
const verdict = await verifyCheckifyResult(requestId);
if (!verdict.allow) {
return res.status(403).json({ error: "Verification required" });
}
// Continue protected action
} catch (err) {
console.error("Checkify verification unavailable", err);
return res.status(403).json({
error: "Verification is temporarily unavailable. Please try again.",
});
}
The Checkify monorepo includes @checkify/server (Node.js) and checkify-server (Python) packages for server-side verify calls. There is no published OpenAPI spec or Postman collection yet — use the examples on this page and POST /v1/qr/results/verify directly.
@checkify/server v1.0.0 опубликован на npm. Пакет Python checkify-server входит в монорепозиторий Checkify SDK.
Срок действия завершенных проверок истекает через QR_RESULT_MAX_AGE_SECONDS (по умолчанию 900 секунд / 15 минут). По истечении этого срока проверка возвращает result_expired — пользователю предлагается пройти повторную проверку.
Компоненты JavaScript и SDK обрабатывают состояние сессии для стандартных встраиваемых элементов. Используйте их только при создании пользовательского интерфейса, который вручную вызывает GET /v1/qr/pass/{pass_id}/start.
GET /v1/qr/status?token={poll_token}GET /v1/qr/status/request/{request_id}?status_token={status_token}В случае успеха Checkify возвращает HTTP 200 с success: true и status: completed. Разрешать доступ только при наличии необходимых утверждений (например, human_verified: true).
{
"success": true,
"status": "completed",
"message": "Verification result confirmed",
"request_id": "56a57761-ff5b-42f0-9c97-6c13e223e017",
"site_id": "YOUR_SITE_ID",
"business_id": "YOUR_BUSINESS_ID",
"approved_claims": {
"human_verified": true
},
"approved_fields": [],
"signed_result": {
"payload": { "...": "..." },
"signature": "...",
"signature_algorithm": "EdDSA",
"key_id": "checkify:default"
}
}
Объект signed_result позволяет бэкенду хранить защищённую от подделки аудиторскую запись о том, что Checkify одобрил требуемый claim в момент проверки. Большинству интеграций достаточно approved_claims. Регулируемым или высокорисковым компаниям можно также хранить signed_result. Вложенный proof_metadata может содержать криптографические или операционные свидетельства (метаданные assurance, типы evidence или хэши согласия) — не документы удостоверения личности и не сырую дату рождения. Не считайте вложенные поля assurance сертификацией или гарантией доверия; проверяйте certification_status и свою политику. Не храните больше персональных данных, чем необходимо.
Если клиент еще не завершил работу в приложении, Checkify возвращает HTTP 200 с success: false и status: pending. Запретить защищенные действия и попросить пользователя завершить проверку.
{
"success": false,
"status": "pending",
"message": "Verification is not completed yet",
"request_id": "56a57761-ff5b-42f0-9c97-6c13e223e017",
"approved_claims": {},
"signed_result": null
}
| Поле | Значение |
|---|---|
success | true когда проверка завершена и требования соответствуют |
status | completed или pending |
approved_claims | Утверждения Checkify одобрены, например. human_verified: true |
signed_result | Дополнительные подписанные полезные данные для контрольного журнала |
Если проверка не может быть продолжена, Checkify возвращает HTTP 4xx/5xx со структурированным телом JSON. Проверьте error.code и запишите error.detail на стороне сервера. Верните конечным пользователям общие сообщения.
{
"success": false,
"error": {
"code": "verification_failed",
"message": "The verification did not include all required claims.",
"details": {
"missing_claims": ["age_over_18"]
}
}
}
| Код | HTTP | Значение | Рекомендуемые действия |
|---|---|---|---|
missing_authorization | 401 | Заголовок авторизации не был отправлен. | Отправка авторизации: Bearer YOUR_SITE_API_KEY только из серверного кода. |
invalid_token | 401 | Отсутствует, имеет некорректный формат или является недействительным ключом сайта API. | Проверьте ключ на панели управления вашей компании и сохраните его в переменных среды. |
expired_token | 401 | Ключ сайта API был отозван. | Создайте новый ключ сайта API и выполните его ротацию на ваших серверах. |
missing_required_field | 400 / 422 | В теле запроса JSON отсутствует request_id или token. | Передайте request_id из скрытого поля формы или токен опроса, если ваша интеграция все еще его использует. |
invalid_request_id | 400 | Ссылка не может быть обработана или оказывается пустой после нормализации. | Убедитесь, что ваш фронтенд отправляет request_id без изменений. |
result_not_found | 404 | Запрос на подтверждение по данной ссылке отсутствует. | Отклонить действие. Возможно, пользователь изменил скрытое поле или отправил данные из старой сессии. |
result_expired | 410 | Проверка была завершена слишком давно, чтобы доверять ей в данном случае. | Предложите пользователю повторно выполнить сканирование и вызвать функцию проверки с новым request_id. |
verification_failed | 403 / 409 | Несовпадение сайта/бизнеса, уже использованный результат (HTTP 409) или общая ошибка проверки. | Отклоните доступ. Проверьте error.details. Для пробелов в claims/полях см. missing_required_claims и missing_required_fields. |
missing_required_claims | 403 | developers_server.err_missing_required_claims_meaning | developers_server.err_missing_required_claims_action |
missing_required_fields | 403 | developers_server.err_missing_required_fields_meaning | developers_server.err_missing_required_fields_action |
unknown_required_attributes | 400 | developers_server.err_unknown_required_attributes_meaning | developers_server.err_unknown_required_attributes_action |
business_not_operational | 403 | Учетная запись компании заблокирована, заархивирована или неактивна. | Обратитесь к владельцу бизнеса или в службу поддержки Checkify. Не разрешайте защищенные действия, пока учетная запись не будет активирована. |
validation_errors | 422 | Тело сообщения JSON не прошло проверку схемы (HTTP 422). | Проверьте error.details.validation_errors на наличие сообщений на уровне полей. Исправьте типы request_id, required_claims или required_fields перед повторной попыткой. |
rate_limited | 429 | Слишком много подтверждающих звонков за короткий промежуток времени. | Повторите попытку с экспоненциальной задержкой. Проверяйте только защищенные действия, а не каждый просмотр страницы. |
server_error | 500+ | Проверка Checkify не может быть завершена из-за временной проблемы с сервером. | Повторите попытку один или два раза, затем закройте окно с ошибкой и зарегистрируйте инцидент. |
Сегодня серверная проверка осуществляется синхронно: ваш бэкэнд проверяет request_id, когда пользователь отправляет защищенное действие. Для процессов оформления заказа, регистрации и контроля доступа это рекомендуемый подход. Для стандартных интеграций не требуются веб-хуки общего назначения для проверки. GoHighLevel и другие партнерские интеграции могут использовать отдельную конфигурацию исходящих веб-хуков в панели управления бизнесом.
Считайте скрытое поле ненадежной ссылкой, а не доказательством. Прежде чем предоставлять доступ, всегда проверяйте ключ API вашего сайта на сервере. Используйте
consume: true
для одноразовых действий, таких как регистрация или сброс пароля.