DocumentDetector

Importando o SDK

Para utilizar o DocumentDetector, você pode tanto importar remotamente o arquivo .js como baixá-lo localmente.

Remotamente

Inclua o arquivo .js diretamente do CDN:

<script src="https://repo.combateafraude.com/javascript/release/document-detector/<VERSION>/document-detector.min.js" type="text/javascript"></script>

Localmente

Baixe o arquivo .js e importe-o como um módulo ES6:

import * as DocumentDetector from '../assets/js/document-detector.min.js'

Utilização

Para iniciar o DocumentDetector, primeiro crie uma instância:

const token = '<MOBILE_TOKEN>';
const options = {
  mobileOnly: true,
  theme: {
    closeButton: '#39c560',
    checkmark: '#39c560',
    alertButton: '#39c560',
    loader: '#39c560',
    cameraSwitch: '#39c560',
    pictureButton: '#39c560'
  },
};

const documentDetector = new DocumentDetector.initialize(token, options);

Parâmetros de options:

Campo	Tipo	Valor padrão	Descrição
disableAnalytics	boolean	false	Desabilitar o analytics
mobileOnly	boolean	false	Permitir apenas dispositivos móveis
theme.closeButton	string	#39c560	Cor do botão de fechar (em hexadecimal)
theme.checkmark	string	#39c560	Cor do checkmark de sucesso (em hexadecimal)
theme.alertButton	string	#39c560	Cor do botão dos alerts/popups (em hexadecimal)
theme.loader	string	#39c560	Cor do loader/spinner (em hexadecimal)
theme.cameraSwitch	string	#39c560	Cor do switch das câmeras (em hexadecimal)
theme.pictureButton	string	#39c560	Cor do botão capturar foto (em hexadecimal)

Nota: o SDK realiza algumas rotinas antes de estar pronto para uso. Recomendamos que você use o SDK somente após a emissão do evento ready:

documentDetector.on('ready', () => {
  console.log('DocumentDetector ready!');
});

Nesse momento, const documentDetector contém o método open.

const documentType = 'RG'; // RG or CNH

// Opens a modal and starts document detection (documentType is required)
documentDetector.open(documentType).then(() => {
  // Successfully started
}).catch((err) => {
  // Couldn't start. See the error page for more details
});

Para obter o resultado, adicione o seguinte event listener:

documentDetector.events.on('finished', (e) => {
  console.log(e.detail);
});

O resultado é um objeto que contém os seguintes campos:

Campo	Tipo	Descrição
documentType	string	Tipo de documento que foi capturado
captureFront.imagePath	string	Blob da frente do documento
captureBack.imagePath	string	Blob do verso do documento

Para detectar quando o usuário fechou o SDK, adicione o seguinte event listener:

documentDetector.on('closed', () => {
  console.log('DocumentDetector SDK was closed!');
});