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.

Com o by Unico, você terá um time de especialistas em segurança e melhores práticas de UX design para garantir a melhor conversão possível em sua operação. Pode ser utilizada de forma responsiva tanto no Desktop quanto no Mobile. Oferendo as seguintes possibilidades de uso:

Canal	Redirect	Open.window()	iFrame	Webview	Mensagens
Desktop
Webmobile
App mobile

Para o fluxo de mensagens, é possível enviar notificações pelos canais de: WhatsApp e/ou SMS.

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 12.

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:

Flow	Prova de vida	Verificação de Identidade	Alerta de comportamento	Score de Risc	Reaproveitamento e captura de documentos	Assinatura eletrônica	Validação (1:1)	Revalidação Inteligente	Retorno de similaridade da Serpro
idlive
id
idlivetrust
idcheck
iddocs
idsign
iddocssign
idchecktrust
idchecktrustdocs
idchecktrustsign
idchecktrustdocssign
idcheckserpro
idcheckserprodocs
idcheckserprodocssign
creditoconsignado
idtrust
idunicodocs
idunicosign
idunicodocssign
idunicoserprodocssign
idtrustdocs
idtrustsign
idtrustdocssign
idtoken
idtokentrust
idtokensign
idsmart

• Caso utilize a capacidade Reaproveitamento e Captura de documentos, considere que é possível utilizar os seguintes documentos:

  • RG, CNH, CIN e Passaporte brasileiro.

• O flow creditoconsignado é condicional e funciona da seguinte forma:

  • Similaridade Serpro Positiva: Pede assinatura eletrônica.

  • Similaridade Serpro Negativa: Pede documentos para facematch.

    • Facematch Positivo: Pede assinatura eletrônica.

    • Facematch Negativo: Finaliza (não pede assinatura).

Como integrar

---

1

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.

2

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.

3

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á web? Você pode utilizar o Redirect do navegador ou o SDK.

• 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 e SMS (para isso, basta informar o parâmetro correspondente na requisição CreateProcess no passo 2).

4

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.