Embed SDK reference

Install

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

After load, window.Checkify.version reports the SDK release (currently 1.0.4).

HTML auto-mount

The SDK auto-mounts elements with these attributes on page load:

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

Deprecated: data-checkify-launcher still works but logs a console warning. Use Pass + request type instead.

Form integration attributes

When using Checkify.bindForm, you can also set these on the form element:

Checkify.configure(options)

Set global defaults before mounting widgets.

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

Checkify.bindForm(form, options)

Renders a verify button, writes a token to a hidden input, and disables submit until verified.

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

bindForm options

Common options passed as the second argument to Checkify.bindForm(form, options):

Checkify.createHumanGate(options)

Full-page or container gate that blocks content until verification completes.

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

Return URL flow

When users complete verification in the Checkify app, they may return to your site with checkify_request_id in the query string. The SDK calls Checkify.checkReturnedVerification() automatically on load.

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.

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

Server verify

Methods