Incorporar referência SDK

Instalar

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

Após o carregamento, window.Checkify.version informa a versão SDK (atualmente 1.0.4).

Montagem automática de HTML

O SDK monta automaticamente elementos com esses atributos ao carregar a 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 Ainda funciona, mas registra um aviso no console. Use Pass + tipo de solicitação em vez disso.

Atributos de integração de formulário

Ao usar Checkify.bindForm, você também pode definir esses parâmetros no elemento do formulário:

Checkify.configure(options)

Defina as configurações padrão globais antes de montar os widgets.

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

Checkify.bindForm(form, options)

Renders um botão de verificação, escreve um token em um campo de entrada oculto e desabilita o envio até que a verificação seja concluída.

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

opções do bindForm

Opções comuns passadas como segundo argumento para Checkify.bindForm(form, options):

Checkify.createHumanGate(options)

Portal de página inteira ou contêiner que bloqueia o conteúdo até que a verificação seja concluída.

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

Fluxo de URL de retorno

Quando os usuários concluírem a verificação no aplicativo Checkify, eles poderão retornar ao seu site com checkify_request_id na string de consulta. As chamadas SDK Checkify.checkReturnedVerification() automaticamente ao carregar.

Checkify.verificar(opções)

Inicia a verificação programaticamente sem a necessidade de montagem automática de HTML. Retorna uma promessa que é resolvida quando o usuário conclui ou cancela a ação.

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

Eventos

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

Consulta de status (opcional)

A maioria das integrações deve verificar o status no envio do formulário com o método POST /v1/qr/results/verify. Para interfaces personalizadas sem o recurso incorporado, você pode consultar o status enquanto o usuário completa a verificação no aplicativo.

• Token de pesquisa legado de versões anteriores incorporadas:
• ID da solicitação + token de status da resposta inicial:

Verificação do servidor

Métodos