Guia da API

A API REST permite que você, ao fazer a integração com o Unico IDDocs, alcance seu objetivo. A API utiliza requisições e respostas no formato JSON e possui um sistema de autenticação baseado em JWT Bearer.

Principais Recursos

O IDDocs é usado juntamente com o IDUnico utilizando a biometria facial para a autenticação de pessoas e captura de documentos durante a criação de um processo.

O método CreateProcess cria um processo enviando as imagens e as informações da pessoa.

O método GetProcessobtem o resultado do processo criado. É usado com o ID retornado no método CreateProcess

Esse método pode ser utilizado a cada 2 segundos para verificar o status do processo. Para mais informações sobre todos os status possíveis, consulte Status do Processo.

APIKey Síncrona

Quando a configuração da APIKey for Síncrona, o resultado do Unico IDDocs é devolvido no retorno do método CreateProcess.

APIKey Assíncrona

Caso a configuração de sua APIKey seja assíncrona, o resultado do Unico IDDocs é devolvido no retorno do método GetProcess.

As API Keys que utilizam a combinação Unico IDDocs + IDCheck terão o resultado do score de forma assíncrona, sendo necessário o uso do método GetProcess para a obtenção do valor do Score de Autenticação.

Antes de iniciar a integração, certifique-se que você possui credenciais válidas para utilização do produto.

Obtenha um token OAuth válido;

Para efetuar requisições à API REST você precisa de um token de acesso OAuth válido. Caso não esteja familiarizado com o modelo de autenticação OAuth, entenda como gerar um token válido neste artigo. Após a geração, o token de acesso deve ser enviado no header de sua requisição, junto ao parâmetro Authorization.

Ambientes

Ao iniciar a integração você receberá as credenciais do ambiente de homologação. Somente após o processo de testes e certificação é que você receberá as credenciais de produção.

Você deve apontar suas requisições às URLs corretas em cada estágio de sua integração. Abaixo estão listadas informações de IP e Porta de homologação e produção:

• Ambiente de homologação: https://api.id.uat.unico.app/;
• Ambiente de produção: https://api.id.unico.app/;
• Porta padrão: 443.

AMBIENTE PARA TESTES

• Você pode utilizar a API em um ambiente de homologação para testar as funcionalidades evitando afetar seu entorno produtivo.

• No ambiente de homologação (UAT) nenhuma face está cadastrada, sendo assim, qualquer imagem pode ser enviada.

• Se enviar com CPF (code) “12345678909” o retorno é sempre yes. Qualquer outro CPF o retorno é sempre inconclusive.

• Para os demais dados (name, email, phone) qualquer valor pode ser enviado.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.