Visão Geral
Nesta seção, você encontrará todas as especificações técnicas das APIs REST do by Unico
Atualizado
Isto foi útil?
Portuguese (Brazil)
Nesta seção, você encontrará todas as especificações técnicas das APIs REST do by Unico
Atualizado
Isto foi útil?
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.
Compatível com todos os dispositivos com câmera frontal, seja em laptops ou mobile, respeitando a lista de navegadores oficialmente suportados abaixo:
Demais navegadores não são suportados.
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
id
idlivetrust
idtrust
idunicodocs
idunicodocssign
idtrustdocs
idtrustsign
idtrustdocssign
idtoken
idtokentrust
idtokensign
A capacidade Score de risco está sendo descontinuada e só poderá ser utilizada em casos excepcionais.
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.
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.
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 e SMS (para isso, basta informar o parâmetro correspondente na requisição CreateProcess no passo 2).
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.
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.
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.
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.
