Embed SDK-referentie

Installeren

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

Na het laden rapporteert window.Checkify.version de SDK-release (momenteel 1.0.4).

HTML auto-mount

De SDK mount automatisch elementen met deze attributen bij het laden van de pagina:

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

Verouderd: data-checkify-launcher werkt nog, maar logt een consolewaarschuwing. Gebruik in plaats daarvan Pass + verzoektype.

Formulierintegratie-attributen

Bij gebruik van Checkify.bindForm kun je deze ook op het formulierelement zetten:

Checkify.configure(options)

Stel wereldwijde standaardwaarden in vóór het mounten van widgets.

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

Checkify.bindForm(form, options)

Rendert een verify-knop, schrijft een token naar een verborgen input en schakelt submit uit tot verificatie is voltooid.

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

bindForm-opties

Veelgebruikte opties als tweede argument van Checkify.bindForm(form, options):

Checkify.createHumanGate(options)

Full-page- of containergate die content blokkeert tot verificatie is voltooid.

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

Return-URL-flow

Wanneer gebruikers verificatie in de Checkify-app voltooien, kunnen ze terugkeren naar je site met checkify_request_id in de querystring. De SDK roept Checkify.checkReturnedVerification() automatisch aan bij het laden.

Checkify.verify(options)

Start verificatie programmatisch zonder HTML auto-mount. Geeft een promise terug die resolve’t wanneer de gebruiker afrondt of annuleert.

const result = await Checkify.verify({
  passId: 'YOUR_PASS_ID',
  requestType: 'human',
  target: document.getElementById('checkify-root'),
  autoOpenModal: true
});
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:return', (e) => {
  console.log('Returned from app', e.detail);
});

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

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

Statuspolling (optioneel)

De meeste integraties moeten bij formuliervoorlegging verifiëren met POST /v1/qr/results/verify. Voor eigen frontends zonder embed kun je de status pollen terwijl de gebruiker verificatie in de app voltooit.

• Legacy poll-token van oudere embeds:
• Request ID + status-token uit de start-response:

Server verify

Methoden