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

Вставьте ссылку SDK

Браузер API для проверки Checkify Pass. URL-адрес CDN: https://checkify.me/sdk/v1/checkify.min.js

Install

<script src="https://checkify.me/sdk/v1/checkify.min.js"></script>

После загрузки window.Checkify.version сообщает о выпуске SDK (в настоящее время 1.0.1).

Автоматическое монтирование HTML

. SDK автоматически монтирует элементы с этими атрибутами при загрузке страницы:

<div
  data-checkify-pass="YOUR_PASS_ID"
  data-checkify-request="human"
  data-checkify-text="Verify with Checkify"
  data-checkify-return-url="https://yoursite.com/done"
></div>

Устарело: data-checkify-launcher все еще работает, но регистрирует предупреждение консоли. Вместо этого используйте тип запроса Pass +.

МетодОписание
data-checkify-passYour Checkify Pass public ID (required)
data-checkify-requestRequest type: human, age_over_18, age_over_21, age_over_25, or age_over_N
data-checkify-textButton label text
data-checkify-return-urlOptional URL to return to after app handoff
data-checkify-launcherDeprecated launcher ID — use data-checkify-pass instead

Checkify.configure(options)

Установите глобальные настройки по умолчанию перед установкой виджетов.

Checkify.configure({
  baseUrl: 'https://checkify.me',
  completeUrl: '/checkify/complete'
});

Checkify.bindForm(form, options)

Render — это кнопка проверки, записывает токен на скрытый вход и отключает отправку до тех пор, пока она не будет проверена.

Checkify.bindForm('#my-form', {
  passId: 'YOUR_PASS_ID',
  requestType: 'human',
  buttonTarget: '#checkify-wrap',
  submitButton: '#submit',
  hiddenInput: '#checkify_token',
  disableSubmitUntilVerified: true
});

Checkify.createHumanGate(options)

Полностраничный или контейнерный шлюз, который блокирует контент до завершения проверки.

Checkify.createHumanGate({
  passId: 'YOUR_PASS_ID',
  requestType: 'human',
  container: '#gate-root',
  title: 'Verify to continue'
});

Поток URL-адресов возврата

Когда пользователи завершают проверку в приложении Checkify, они могут вернуться на ваш сайт с checkify_request_id в строке запроса. SDK автоматически вызывает Checkify.checkReturnedVerification() при загрузке.

Checkify.verify(options)

Start verification programmatically without auto-mounting HTML. Returns a promise that resolves when the user completes or cancels.

const result = await Checkify.verify({
  passId: 'YOUR_PASS_ID',
  requestType: 'human',
  container: document.getElementById('checkify-root')
});
console.log(result.requestId); // send to your server as request_id

Events

window.addEventListener('checkify:verified', (e) => {
  console.log('Verified', e.detail);
});

window.addEventListener('checkify:error', (e) => {
  console.error('Checkify error', e.detail);
});

Status polling (optional)

Most integrations should verify on form submit with POST /v1/qr/results/verify. For custom frontends without the embed, you may poll status while the user completes verification in the app.

Проверка сервера

Methods

МетодОписание
Checkify.mount(root?)Виджеты Mount Pass под необязательным корневым элементом
Checkify.bindForm(...)Помощник по интеграции форм
Checkify.createHumanGate(...)Пользовательский интерфейс шлюза проверки человека
Checkify.verify(options)Последовательность программной проверки
Checkify.checkReturnedVerification()Обработка возвращаемого URL-адреса после передачи приложения