Pular para o conteúdo principal

Guia da API

A API REST permite que você, ao fazer a integração com o IDUnico, 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​

Através da API você gerencia transações através da biometria facial. A seguir os principais recursos da API.

  • CreateProcess - Criar nova transação biométrica;
  • GetProcess - Consultar informações de uma transação biométrica;

O IDUnico disponibiliza os dados na integração de duas formas: Síncrona ou Assíncrona. Na configuração da API Key, você pode escolher como deseja se integrar para receber os resultados do IDUnico. Fale com o gerente de projetos responsável por sua conta para a definição da configuração desejada.

Ao optar pela configuração Assíncrona, o resultado do IDUnico só é devolvido no retorno do método GetProcess.

Já na configuração Síncrona, ao chamar o método CreateProcess, o resultado do IDUnico é devolvido no retorno desse método.

Observação

As API Keys que utilizam a combinação IDUnico + 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.

Importante
  • É possível combinar os resultados do Unico IDLive e IDUnico. Com a combinação, você tem a opção de usar o Unico IDLive no topo do seu funil para verificar a prova de vida e então, quando for necessário, usar o GetProcess do IDunico para obter informações da autenticidade do CPF. Para isso, você precisa ter habilitado o Unico IDLive através da API Key.

Para mais informações sobre o Unico IDLive, consulte Unico IDLive - Visão Geral

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.