Checkify
Documenti per sviluppatori

Incorpora SDK riferimento

Browser API per Verifica Checkify Pass. URL CDN: https://checkify.me/sdk/v1/checkify.min.js

Installa

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

Dopo il caricamento, window.Checkify.version segnala la versione SDK (attualmente 1.0.4).

Montaggio automatico HTML

Il SDK monta automaticamente gli elementi con questi attributi al caricamento della 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>

Deprecato: data-checkify-launcher funziona ancora ma registra un avviso sulla console. Utilizza invece il tipo di richiesta Pass +.

MetodoDescrizione
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-fieldsOptional comma-separated identity fields to request (for example country)
data-checkify-proofsOptional comma-separated proof types when your Pass supports multiple proofs
data-checkify-launcherDeprecated launcher ID — use data-checkify-pass instead

Form integration attributes

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

MetodoDescrizione
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-formImposta data-checkify-pass (o data-checkify-form) su un form per collegarlo automaticamente al caricamento della pagina senza chiamare bindForm manualmente. data-checkify-auto non è supportato.
data-checkify-hidden-inputCSS selector for the hidden input that receives request_id (default: input[name=checkify_token])

Checkify.configure(options)

Imposta le impostazioni predefinite globali prima di montare i widget.

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

Checkify.bindForm(form, options)

Renders è un pulsante di verifica, scrive un token su un input nascosto e disabilita l'invio fino alla verifica.

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

MetodoDescrizione
passIdCheckify Pass public ID (required unless set on the form via data-checkify-pass)
requestTypeRequest type (human, age_over_18, etc.)
buttonTargetContainer element where the verify button is rendered
submitButtonSubmit control to enable after verification
hiddenInputHidden field selector for request_id
disableSubmitUntilVerifiedWhen true, keeps submit disabled until verification succeeds

Checkify.createHumanGate(options)

Porta a pagina intera o contenitore che blocca il contenuto fino al completamento della verifica.

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

Flusso URL di ritorno

Quando gli utenti completano la verifica nel Checkify app, potrebbero tornare al tuo sito con checkify_request_id nella stringa di query. Il SDK chiama Checkify.checkReturnedVerification() automaticamente al caricamento.

Checkify.verify(options)

Avvio programmatico senza bindForm. Passa un elemento DOM come target (non container — container è solo per createHumanGate). Preferisci bindForm per i form. Restituisce una promise che si risolve quando l’utente completa o annulla.

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

Eventi

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

Verifica server

Metodi

MetodoDescrizione
Checkify.mount(root?)Widget Mount Pass sotto l'elemento root opzionale
Checkify.bindForm(...)Assistente integrazione modulo
Checkify.createHumanGate(...)Porta di verifica umana UI
Checkify.verify(options)Flusso di verifica programmatica
Checkify.checkReturnedVerification()Gestisci l'URL di ritorno dopo il trasferimento dell'app