Ir para o conteúdo

Instalando o SDK

Bem-vindo ao nosso guia de integração de validação de identidade. Esta documentação fornece instruções detalhadas sobre como integrar nosso sistema de validação de identidade em sua aplicação usando nosso SDK. O sistema permite a verificação segura e eficiente da identidade do usuário diretamente em sua aplicação, melhorando a experiência do usuário ao eliminar a necessidade de redirecionamentos externos.

Nosso processo de validação de identidade inclui:

  • Validação de Documento OCR: Verifica a autenticidade e os detalhes do documento do usuário.
  • Liveness: Garante que o usuário esteja fisicamente presente durante a validação.
  • Facematch: Compara a selfie do usuário com a foto em seu documento.

Ao final do processo de validação, seu sistema receberá uma notificação por webhook. Você poderá então recuperar os resultados detalhados da validação utilizando nossa API.

Instalando a biblioteca

Confira um exemplo de como instalar a biblioteca com npm, yarn ou CDN.

Execute

npm install @paag-io/sdk-identity-validation
ou 
yarn add @paag-io/sdk-identity-validation
ou 
<script src="./dist/sdk-identity-validation.umd.development.js"></script>

Configuração

O iframe é criado dinamicamente com as seguintes permissões e configurações:

  • Permissões automáticas para camera e microphone.
  • Utiliza restrições de sandbox para aumentar a segurança.
  • Para iframes em tela cheia, usa position: fixed no CSS, cobrindo toda a tela.

Params:

  • host: A URL do serviço de validação (por exemplo, https://seu-host-de-validacao.com). Para obter a URL, por favor, entre em contato com nossa equipe de suporte.
  • token: O token para acessar o serviço de validação. Para obter o token, por favor, entre em contato com nossa equipe de suporte.
  • target: (Opcional) O elemento HTML onde o iframe será incorporado. Se não for fornecido, o iframe ocupará toda a tela.

Examplo de instanciação

import IdentityValidation from '@paag-io/sdk-identity-validation';

const identityValidation = new IdentityValidation({
  host: 'https://your-host-of-validation.com',
  token: 'your-token',
  // target: document.querySelector('#target-element'), // Opcional
});

Métodos disponíveis

Conheça os métodos disponíveis na sessão seguinte