Integração

Importando o SDK

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

Via NPM (link do pacote)

npm i @combateafraude/identity-sdk

Remotamente

Inclua o arquivo .js diretamente do CDN:

<script src="https://repo.combateafraude.com/identity/<VERSION>/index.js" type="text/javascript">
</script>

Versões atuais

SDK	Categoria	Versão
Identity	Estável	0.0.19

Utilização

Criando uma instância do SDK

O método construtor do SDK recebe como parâmetro o token do Identity (veja como obter o seu aqui). Além disso, você pode, opcionalmente, informar as opções de inicialização do SDK.

Exemplo usando importação via NPM:

import IdentitySdk from '@combateafraude/identity-sdk';

const identityToken = 'seu token';
const identity = new IdentitySdk(identityToken);

Exemplo usando importação via CDN:

<script src="https://repo.combateafraude.com/identity/0.0.9/index.js" type="text/javascript">
</script>

[...]

<script>
    const identityToken = 'seu token';
    const identity = new this['@combateafraude/identity-sdk'].Sdk(identityToken);
</script>

Parâmetros de options:

Campo	Tipo	Obrigatório?	Descrição
mobileToken	boolean	Não*	Um token válido para prova de vida passiva nos SDKs mobile. Veja como gerar o seu aqui.
throwOnRecall	boolean	Não	Indica se, ao ser chamado uma segunda vez sem que a primeira tenha concluído, o SDK deve disparar um erro. Caso não informado ou informado false, o SDK retorna a Promise existente sem disparar erros. Se informado true, o SDK rejeita a Promise na segunda chamada.
theme	-	Não	Para ver todos os parâmetros disponiveis no theme clique aqui.
smsLabel	-	Não	Para ver todos os parâmetros disponiveis na label clique aqui.
emailLabel	-	Não	Para ver todos os parâmetros disponiveis no label clique aqui.
authIcon	string	Não	Ícone usado no topo das telas de autenticação
enableTimer	boolean	Não	Habilita ou não o timer no caso de validação por SMS e E-mail

*Você deve informar o mobileToken quando estiver utilizando a autenticação facial na sua política

Parâmetros de theme:

Campo	Tipo	Obrigatório?	Descrição
closeButton	string	Não	Cor utilizada no botão close
checkmark	string	Não	Cor utilizada no botão checkMark
loader	string	Não	Cor utilizada no botão loader
buttonSuccessColor	string	Não	Cor utilizada no botão de sucesso
inputSuccessColor	string	Não	Cor utilizada nos input de código
buttonFinishColor	string	Não	Cor utilizada nos input de código
timerBackgroundColor	string	Não	Cor utilizada no fundo do timer caso esteja ativo
timerColor	string	Não	Cor utilizada no texto do timer caso esteja ativo
pendingIconSvg	string	Não	Ícone usado na tela de aviso de contexto pendente

Parâmetros de label:

Campo	Tipo	Obrigatório?	Descrição
enable	string	Não	Habilita ou não a label
link	string	Não	link de redirecionamento
text	string	Não	Texto utilizado na label

Exemplo:

const identityOptions = {
mobileToken: 'seu token mobile',
throwOnRecall: true,
theme: {
    closeButton: '#000037',
    pendingIconSvg:'./example.svg'
},
smsLabel: {
    enable: true,
    link: "https://www.google.com/",
    text: "Its just a test SMS",
},
enableTimer: true,
authIcon:  (new Image().src = "./exemple-sdk.png"),
};
const identityToken = 'seu token';
const identity = new IdentitySdk(identityToken, identityOptions);

Chamando o SDK:

Para verificar um usuário, use o método verifyPolicy, disponível na instância do SDK.

Você deve informar o CPF do usuário e o ID da política a ser utilizada.

const cpf = 'CPF do usuário';
const policyId = 'ID da política'

const response = await identity.verifyPolicy(cpf, policyId);

if(identity.isSdkError(response)) {
    // Erro ao executar o SDK
}
else {
    const { isAuthorized, attestation } = response;

    if(isAuthorized) {
        // Usuário está autorizado
        // Enviar a attestation para seu backend e validá-la lá
    }
    else {
        // Usuário não está autorizado
    }
}