AddressCheck

Importando o SDK

Para utilizar o SDK, você deve importá-lo. Você pode fazer isso a partir do nosso CDN ou dos arquivos locais.

CDN

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

Localmente

import * as AddressCheck from '../assets/js/address-check.min.js'

Utilização

Para inicializar o SDK, use a função initialize, passando as opções desejadas.

const token = '<MOBILE_TOKEN>';

const options = {
  mobileOnly: true,
  disableAnalytics: false,
  enableHighAccuracy: true,
  maximumAge: 60000,
  timeout: 15000,
};

const addressCheck = new AddressCheck.initialize(token, options);

Opções suportadas

Campo	Tipo	Valor padrão	Descrição
disableAnalytics	boolean	false	Desabilitar o analytics
mobileOnly	boolean	false	Permitir apenas dispositivos móveis
enableHighAccuracy	boolean	true	Cor do botão de fechar (em hexadecimal)
maximumAge	number	60000	Cor do checkmark de sucesso (em hexadecimal)
timeout	number	15000	Cor do botão dos alerts/popups (em hexadecimal)

Eventos

Evento	Descrição
ready	Disparado quando o SDK está pronto para o uso
error	Disparado quando o SDK encontrou um erro
finished	Disparado quando o SDK terminou de executar a verificação do endereço

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:

addressCheck.on('ready', event => {
    console.log('AddressCheck is ready to be used');
});

addressCheck.on('error', event => {
    console.log('AddressCheck received an error');
    console.log(e.detail);
});

addressCheck.on('finished', event => {
    console.log('AddressCheck finished checking the address');
    console.log(e.detail);
});

Usando o SDK

addressCheck.on('finished', event => {
    console.log('AddressCheck finished checking the address');
    console.log(e.detail);
    /* Resultado: 
    {
        requestId: "6fdf5f24-ee50-498c-8553-db38b00a95cf", 
        locationMatch: false, 
        addressMatch: false, 
        ipMatch: true
    }
    */
});

const address = {
    street: 'Rua Lagoa Clara',
    number: '100',
    complement: 'Ap 201',
    neighborhood: 'Parque Savoy City',
    city: 'São Paulo',
    state: 'São Paulo',
    country: 'Brasil',
    zipCode: '03570390',
};

addressCheck.startValidation('<CPF>', address);

Campos da resposta

Campo	Tipo	Descrição
requestId	string	Identificador da requisição
locationMatch	boolean	Indica se o usuário está no endereço informado
addressMatch	boolean	Indica se o endereço informado é conhecido como um endereço pertencente a este CPF
ipMatch	boolean	Indica se o IP usado para fazer a requisição pertence a mesma cidade do endereço

Erros

Todos os erros disparados pelo SDK possuem campos padronizados. São eles:

Campo	Tipo	Descrição
code	string	Código identificador do erro
description	string	Descrição do erro
details (opcional)	object	Informações adicionais

Os valores válidos para o campo code são:

• INVALID_TOKEN
• DEVICE_NOT_ALLOWED
• BROWSER_NOT_SUPPORTED
• FAILED_TO_RETRIEVE_DATA
• PERMISSION_NOT_GRANTED
• PERMISSION_DENIED
• SDK_NOT_INITIALIZED
• TIMEOUT

Exemplo:

addressCheck.on('error', event => {
    console.log('AddressCheck received an error');
    console.log(e.detail);
    /* Resultado: 
    {
        code: "INVALID_TOKEN", 
        message: "The current token does not have all necessary products and permissions to run this SDK.", 
    }
    */
});