SDK-referentie insluiten

Installeren

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

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

HTML automatisch koppelen

De SDK koppelt automatisch elementen met deze kenmerken 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 steeds, maar registreert een consolewaarschuwing. Gebruik in plaats daarvan Pass + verzoektype.

Formulierintegratieattributen

Wanneer u Checkify.bindForm gebruikt, kunt u deze ook instellen op het formulierelement:

Checkify.configure(options)

Stel algemene standaardwaarden in voordat u widgets koppelt.

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

Checkify.bindForm(form, options)

Geeft een verificatieknop weer, schrijft een token naar een verborgen invoer en schakelt indiening uit totdat deze is geverifieerd.

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

bindForm-opties

Algemene opties die als tweede argument worden doorgegeven aan Checkify.bindForm (formulier, opties):

Checkify.createHumanGate(options)

Volledige pagina- of containerpoort die inhoud blokkeert totdat de verificatie is voltooid.

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

Retour-URL-stroom

Wanneer gebruikers de verificatie in de Checkify-app voltooien, kunnen ze terugkeren naar uw site checkify_request_id in de queryreeks. De SDK belt Checkify.checkReturnedVerification() automatisch bij belasting.

Checkify.verify(opties)

Start de verificatie programmatisch zonder HTML automatisch te koppelen. Retourneert een belofte die wordt uitgevoerd wanneer de gebruiker de overeenkomst voltooit 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

Evenementen

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);
});

Status polling (optioneel)

De meeste integraties moeten worden geverifieerd bij het indienen van een formulier met POST /v1/qr/results/verify. Voor aangepaste frontends zonder insluiting kunt u de status opvragen terwijl de gebruiker de verificatie in de app voltooit.

• Verouderd poll-token van oudere insluitingen:
• Vraag ID + statustoken aan vanaf het startantwoord:

Serververificatie

Methoden