Incrustar SDK referencia

Instalar

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

Después de la carga, window.Checkify.version informa la versión SDK (actualmente 1.0.1).

Montaje automático HTML

El SDK monta automáticamente elementos con estos atributos al cargar la página:

<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>

Obsoleto: data-checkify-launcher todavía funciona pero registra un Advertencia de consola. Utilice el tipo de solicitud Pasar + en su lugar.

Checkify.configure(options)

Establezca valores predeterminados globales antes de montar widgets.

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

Checkify.bindForm(form, options)

Renders un botón de verificación, escribe un token en una entrada oculta y deshabilita el envío hasta que se verifique.

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

Checkify.createHumanGate(options)

Puerta de página completa o contenedor que bloquea el contenido hasta que se completa la verificación.

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

Flujo de URL de retorno

Cuando los usuarios completan la verificación en el Checkify aplicación, pueden regresar a su sitio con checkify_request_id en la cadena de consulta. El SDK llama a Checkify.checkReturnedVerification() automáticamente al cargar.

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

Eventos

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.

• Legacy poll token from older embeds:
• Request ID + status token from the start response:

Verificar servidor

Métodos