Checkify
Документы разработчика

Проверка на вашей серверной части

После завершения внедрения браузера ваш сервер должен проверить результат с помощью ключа сайта API, прежде чем разрешить регистрацию, оформление заказа или любое защищенное действие.

1. Создайте сайт. Ключ API

В панели управления вашего бизнеса откройте Разработчик. и создайте ключ API для сайта, который вы интегрируете. Храните его только в переменных среды сервера — никогда не отправляйте его в браузер.

2. Прочтите ссылку из вашей формы

Вставка SDK записывает request_id в ваше скрытое поле (устаревшие интеграции могут по-прежнему отправлять токен опроса — оба работают).

// Example POST body from your frontend form
{
  "email": "user@example.com",
  "checkify_token": "56a57761-ff5b-42f0-9c97-6c13e223e017"
}

3. Проверка вызова

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.

Пример FastAPI

from checkify_server import Checkify

checkify = Checkify(api_key=os.environ["CHECKIFY_SITE_API_KEY"])

@app.post("/signup")
async def signup(email: str, checkify_token: str):
    result = checkify.verify_human(request_id=checkify_token)
    if not result.get("success") or not result.get("approved"):
        raise HTTPException(status_code=403, detail="Human verification required")
    # continue signup...

Экспресс-пример

import { Checkify } from "@checkify/server";

const checkify = new Checkify({ apiKey: process.env.CHECKIFY_SITE_API_KEY });

app.post("/signup", async (req, res) => {
  const result = await checkify.verifyHuman({
    requestId: req.body.checkify_token,
  });

  if (!result.success || !result.approved) {
    return res.status(403).json({ error: "Human verification required" });
  }

  // continue signup...
});

Обработка ответа

ПолеЗначение
successtrue когда проверка завершена и требования соответствуют
statuscompleted или pending
approved_claimsУтверждения Checkify одобрены, например. human_verified: true
signed_resultДополнительные подписанные полезные данные для контрольного журнала

Напоминание о безопасности

Считайте скрытое поле ненадежной ссылкой, а не доказательством. Прежде чем предоставлять доступ, всегда проверяйте ключ API вашего сайта на сервере. Используйте consume: true для одноразовых действий, таких как регистрация или сброс пароля.