Visão Geral
Nesta seção, você encontrará todas as especificações técnicas das APIs REST do by Unico
Introdução
O by Unico é um canal que oferece uma infraestrutura de soluções de validação de identidade da plataforma IDCloud.
Tem por objetivo, simplificar o uso das capacidades da plataforma IDCloud oferecendo uma solução que pode ser integrada ao seu back-end e front-end e que aumenta a segurança das transações.
Dispositivos compatíveis
Android
Compatível com todos os dispositivos com câmera frontal, Android 8+, armv7 ou arm64.
iOS
Compatível com todos os dispositivos iOS igual ou superior a versão 11.
Web
Compatível com todos os dispositivos com câmera frontal, seja em laptops ou mobile, respeitando a lista de navegadores oficialmente suportados abaixo:
Navegadores nativos
IOS:
versão superior ou igual a 12.
Android:
versão superior ou igual a 5.
Navegadores em dispositivos móveis
Android:
Chrome: versão superior ou igual a 90.
IOS:
Safari: versão superior ou igual a 14.1;
Chrome: versão superior ou igual a 90 (apenas para IOS versão igual superior a 14.4).
Navegadores de computadores/notebooks
Chrome:
versão superior ou igual a 85.
Firefox:
versão superior ou igual a 94.
Safari:
versão superior ou igual a 11.
Demais navegadores não são suportados.
Fluxos possíveis
O by Unico é um meio de integração do Unico IDCloud que permite que os clientes se integrem de forma mais simples e consigam conectar diferentes capacidades em uma mesma jornada. Esse meio de integração fornece os recursos necessários para realizar Prova de vida, Verificação de Identidade, Score de risco, Captura e reaproveitamento de documentos e Assinatura eletrônica.
Para isso, você irá mudar apenas o parâmetro flow no payload da REST API, e com isso terá diversas possibilidades de jornadas de verificação.
Verifique abaixo a tabela relacionando os flows disponíveis e suas respectivas capacidades:
idlive
Prova de vida
id
Prova de vida + Verificação de Identidade
idlivetrust
Prova de vida + Alerta de comportamento
idtrust
Prova de vida + Verificação de Identidade + Alerta de comportamento
idcheck
Prova de vida + Verificação de Identidade + Score de risco
iddocs
Prova de vida + Verificação de Identidade + Score de risco + Reaproveitamento e captura de documentos
idsign
Prova de vida + Verificação de Identidade + Score de risco + Assinatura eletrônica
iddocssign
Prova de vida + Verificação de Identidade + Score de risco + Reaproveitamento e captura de documentos + Assinatura eletrônica
idchecktrust
Prova de vida + Verificação de Identidade + Score de risco + Alerta de comportamento
idchecktrustdocs
Prova de vida + Verificação de Identidade + Score de risco + Alerta de comportamento + Reaproveitamento e captura de documentos
idchecktrustsign
Prova de vida + Verificação de Identidade + Score de risco + Alerta de comportamento + Assinatura eletrônica
idchecktrustdocssign
Prova de vida + Verificação de Identidade + Score de risco + Alerta de comportamento + Reaproveitamento e captura de documentos + Assinatura eletrônica
idcheckserpro
Prova de vida + Verificação de Identidade + Score de risco + Retorno de similaridade da Serpro
creditoconsignado
Prova de vida + Verificação de Identidade + Score de risco + Retorno de similaridade da Serpro + Assinatura eletrônica
Este fluxo funciona na forma de uma condicional:
Se o retorno de similaridade da Serpro for positivo, solicitamos a assinatura eletrônica;
Se o retorno de similaridade da Serpro for negativo, pedimos os documentos do usuário para realizar o facematch:
Se o resultado do facematch for positivo, solicitamos a assinatura eletrônica;
Se o resultado do facematch for negativo, finalizamos a jornada sem pedir a assinatura eletrônica.
idcheckserprodocssign
Prova de vida + Verificação de Identidade + Score de risco + Retorno de similaridade da Serpro + Reaproveitamento e captura de documentos + Assinatura eletrônica
idtoken
Prova de vida + Validação (1:1)
idtokentrust
Prova de vida + Validação (1:1) + Alerta de comportamento
idtokensign
Prova de vida + Validação (1:1) + Assinatura eletrônica
Caso utilize a capacidade Reaproveitamento e Captura de documentos, considere:
Reaproveitamento: RG, CNH, CIN e Passaporte brasileiro;
Captura: RG, CNH e Passporte brasileiro.
Como integrar
Se autentique
Primeiramente você deve possuir uma conta de serviço e realizar a autenticação OAuth2 para obter um access-token válido.
Saiba mais em Autenticação.
Crie um processo
Com o access-token obtido no passo anterior, realize uma requisição do tipo POST no endpoint client/v1/process(aqui você informará o "flow" que deseja utilizar).
Saiba mais em CreateProcess.
Defina onde será a jornada do seu usuário
Nesta etapa você irá definir onde será a jornada do seu usuário.
A jornada será no seu app? Você pode utilizar uma Webview.
A jornada será no fluxo de mensagens? Você pode enviar notificações via WhatsApp, SMS e E-mail (para isso, basta informar o parâmetro correspondente na requisição CreateProcess no passo 2).
Consulte o resultado do processo
Com o access-token obtido no passo 1, realize uma requisição do tipo GET no endpoint client/v1/process/{id}(aqui você informará o "id" do processo que foi criado no passo 2), consulte o resultado do processo e tome a decisão de aprovar ou não o usuário.
Saiba mais em GetProcess.
Para otimizar sua integração, você pode utilizar o Webhook e saber quando o resultado do seu processo estiver concluído.
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.
Atualizado