Loading...
Loading...
Nesta seção, você encontrará todas as APIs REST disponíveis para utilização do meio de integração by Unico
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Nesta seção, você entrará os componentes que podem ser utilizados com o by Unico
Loading...
Loading...
Loading...
Loading...
Loading...
Nesta seção, você encontrará os recursos adicionais relacionados ao meio de integração by Unico
Loading...
Nesta seção, você encontrará como obter o resultado de um processo no by Unico através da API REST
Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.
Você pode ver mais sobre como gerar um access-token aqui.
state = PROCESS_STATE_FINISHED E result = PROCESS_RESULT_OK;
ENTÃO, pode realizar a tomada de decisão analisando os retornos do parâmetro authenticationInfo.
Caso receba o state = PROCESS_STATE_FINISHED com os resultados result = PROCESS_RESULT_INVALID_IDENTITY ou PROCESS_RESULT_ERROR, interprete que houve algum erro na biometria e tente novamente.
Para verificar detalhadamente os parâmetros da API, consulte a seção Especificação de parâmetros.
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.
| code | message | Descrição |
|---|---|---|
| message | Descrição |
|---|---|
| code | message | Descrição |
|---|---|---|
| code | message | Descrição |
|---|---|---|
3
process id is invalid
Quando o id de processo é inválido.
Jwt header is an invalid JSON
Quando o access-token utilizado contém caracteres errados.
Jwt is expired
Quando o access-token utilizado expirou
5
error getting process: rpc error: code = NotFound desc = process not found
Quando o id do processo não foi encontrado
99999
Internal failure! Try again later
Quando há algum erro interno.
Nesta seção, você encontrará todas as especificações técnicas das APIs REST da plataforma Unico IDCloud, utilizando o meio de integração by Unico
Nesta seção, você encontrará todas as especificações técnicas das APIs REST do by Unico
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.
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.
| Flow | Capacidades |
|---|---|
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, SMS e E-mail (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.
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.
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.
Nesta seção, você encontrará exemplos de requisições de CreateProcess no by Unico
Para uma jornada apenas com validação da prova de vida.
Para uma jornada com validação da prova de vida + verificação de identidade.
Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId.
Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + captura e reaproveitamento de documentos.
Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + assinatura eletrônica.
Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + captura e reaproveitamento de documentos + assinatura eletrônica.
Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + retorno de similaridade da Serpro.
Para uma jornada com validação da prova de vida + validação (1:1)
Para utilizar o Postman, siga os passos:
Selecione o método POST.
Insira a URL https://api.cadastro.uat.unico.app/client/v1/process/.
Selecione a aba Authorization.
Na lista de Type, selecione Bearer Token.
Insira o token obtido no campo Token com o prefixo Bearer .
Selecione a aba Body e insira os dados abaixo de acordo com sua necessidade.
| Android SDK | iOS SDK |
|---|---|
| Navegadores nativos | Navegadores em dispositivos móveis | Navegadores de computadores/notebooks |
|---|---|---|
Para verificar detalhadamente os parâmetros da API, consulte a seção .
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da .
idlive
Prova de vida
id
Prova de vida + Verificação de Identidade
idcheck
Prova de vida + Verificação de Identidade + Score de risco
iddocs
Prova de vida + Verificação de Identidade + Score de risco + Captura e reaproveitamento 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 + Captura e reaproveitamento de documentos + Assinatura eletrônica
idcheckserpro
Prova de vida + Verificação de Identidade + Score de risco + Retorno de similaridade da Serpro
idtoken
Prova de vida + Validação (1:1)
Compatível com todos os dispositivos com câmera frontal, Android 8+, armv7 ou arm64.
Compatível com todos os dispositivos iOS igual ou superior a versão 11.
IOS:
versão superior ou igual a 12;
Android:
versão superior ou igual a 5.
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).
Chrome:
versão superior ou igual a 85;
Firefox:
versão superior ou igual a 94;
Safari:
versão superior ou igual a 11.
Nesta seção, você encontrará todos os cenários de response para processos finalizados no by Unico
Para uma jornada apenas com validação da prova de vida.
Para uma jornada com validação da prova de vida + verificação de identidade.
Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId.
Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + captura e reaproveitamento de documentos.
Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + assinatura eletrônica.
Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + captura e reaproveitamento de documentos + assinatura eletrônica.
Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + retorno de similaridade da Serpro.
Para uma jornada com validação da prova de vida + validação (1:1)
Os exemplos de response acima consideram somente processos que estão com o state = PROCESS_STATE_FINISHED e result = PROCESS_RESULT_OK. Para ver os responses que não consideram somente essas condições, veja a seção Cenários de reponse.
Para verificar detalhadamente os parâmetros da API, consulte a seção Especificação de parâmetros.
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.
Nesta seção, você encontrará como informações redirecionar um usuário em suas aplicações na experiência do by Unico
O campo userRedirectUrl é usado para direcionar o usuário. Esse campo é recebido na resposta de sucesso da criação do processo ao realizar a requisição CreateProcess.
Aqui você encontrará as 3 formas de gerenciar a experiência do usuário em suas aplicações:
Recomenda-se seguir os seguintes passos:
Em seu fluxo comum (que está inserido o Cadastro by Unico) você irá redirecionar o cliente para o link gerado através da API;
Após isso o cliente de dentro da plataforma realiza os procedimentos necessários para continuar o fluxo;
Quando concluído, ele é redirecionado para a sua página (utilizando o redirectUrl passado na criação do processo).
window.open():A opção window.open() consiste em abrir uma nova aba do navegador do usuário para que ele possa completar o processo. Ao final essa aba é fechada e redirecionada para sua aplicação.
Para isso é recomendado:
Seguir a documentação pública sobre isso, que se encontra aqui;
Monitorar se houve alteração de URL (para a redirectUrl) e então fechar a aba utilizando window.close().
1 - Insira no app/build.gradle a dependência necessária para o uso de CustomTabs:
Coloque no AndroidManifest.xml as permissões e intents necessários na Activity que deseja receber a callback_uri.
É necessário incluir o atributo android:launchMode="singleTop" como também a tag <data> informando os dados da URI.
As seguintes permissões são necessárias para funcionar corretamente:
Câmera;
Geolocalização.
Para pegar as informações de redirect com os dados fornecidos, você pode usar o seguinte código no método onNewIntent da sua Activity:
1 - O primeiro passo é criar o controlador de autenticação, e, para isso crie uma classe chamada UnicoAuthenticationController (ou como preferir chamar).
2 - Na sequência, importe o framework AuthenticationServices no topo da classe.
3 - Declare a classe como NSObject e implemente o protocolo ASWebAuthenticationPresentationContextProviding.
O resultado deve ser:
1 - Abra o arquivo onde você executa a autenticação e adicione as importações necessárias (como exemplo, o ContentView.swift é usado).
2 - Para controlar o estado do fluxo é preciso criar a propriedade @State.
3 - Crie uma instância da classe UnicoAuthenticationController fora do corpo da estrutura ContentView.
4 - Para a validação do processo, crie uma função chamada redirectUser.
Ambientes:
Lembre-se de alterar a url URL_AUTHENTICATION para a URL de autenticação recebida em seu processo e também o callbackURLScheme BUNDLE para o redirect informado na criação do processo (o uso do Bundle Identifier de seu aplicativo é recomendado).
Autenticação única:
É importante setar prefersEphemeralWebBrowserSession para true para garantir uma autenticação única por processo.
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.
Nesta seção, você encontrará como criar um processo no by Unico através da API REST
Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.
Você pode ver mais sobre como gerar um access-token aqui.
Para verificar detalhadamente os parâmetros da API, consulte a seção Especificação de parâmetros.
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.
Nesta seção, você encontrará como obter o documento assinado de um processo no by Unico através da API REST
Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.
Você pode ver mais sobre como gerar um access-token aqui.
Produção: https://sign.acesso.io/api/v1/service/file.
Para verificar detalhadamente os parâmetros da API, consulte a seção Especificação de parâmetros.
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.
Nesta seção, você encontrará como obter a selfie de um processo no by Unico através da API REST
Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.
Você pode ver mais sobre como gerar um access-token aqui.
O parâmetro [?raw=true] é opcional. Caso sua conta de serviço tenha a permissão necessária, você poderá utilizá-lo para obter a selfie sem a marca d'água.
Para verificar detalhadamente os parâmetros da API, consulte a seção Especificação de parâmetros.
A selfie do usuário só fica disponível para consulta via REST API durante 8h após a finalização do processo biométrico. Após este período, não é possível recuperar a selfie do usuário.
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.
Nesta seção, você encontrará como obter o conjunto probatório de um processo no by Unico através da API REST
Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.
Você pode ver mais sobre como gerar um access-token aqui.
O conjunto probatório da captura biométrica só fica disponível para consulta via REST API durante 2h após a finalização do processo biométrico. Após este período, não é possível recuperar a selfie do usuário.
Para verificar detalhadamente os parâmetros da API, consulte a seção Especificação de parâmetros.
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.
Nesta seção, você encontrará como obter o conjunto probatório do Sign de um processo no by Unico através da API REST
Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.
Você pode ver mais sobre como gerar um access-token aqui.
Para verificar detalhadamente os parâmetros da API, consulte a seção Especificação de parâmetros.
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.
Nesta seção, você encontrará todas as especificações do conjunto probatório do by Unico
O conjunto probatório é um documento em .pdf contendo evidências de autenticação de um usuário que realizou a validação de identidade no by Unico.
A seguir, veja como este documento é representado, bem como a especificação de seus campos de retorno:
Essas evidências podem ser utilizadas para garantir a autenticidade do processo.
O conjunto probatório só está disponível para os processos finalizados;
O conjunto probatório da captura biométrica só fica disponível para consulta via REST API durante 2h após a finalização do processo biométrico. Após este período, não é possível recuperar a selfie do usuário.
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.
Nesta seção, você encontrará todas as personalizações disponíveis no by Unico
O by Unico disponibiliza algumas personalizações em sua interface, adaptando-se às preferências do cliente para proporcionar uma experiência personalizada e significativa.
É possível personalizar a logo que é apresentada para o usuário final, conforma imagem abaixo:
Para solicitar a inclusão desta logo, é necessário enviar ao time Unico uma URL da logotipo, de modo que essa esteja hospedada em um diretório online (ou seja, esta logo precise ser acessível via URL no navegador).
Não é possível cadastrar uma URL que seja um base64 (geralmente essas URLs iniciam em "data:image/jpeg;base64,/9j/4AAQ...").
Ao longo do processo de implantação, é possível solicitar a configuração da cor e formato dos botões na interface no By Unico, de acordo com a identidade visual da empresa, conforme imagens abaixo:
Para realizar essa configuração, é só enviar as seguintes informações ao time Unico:
Código hexadecimal da cor de background no botão.
Ex: #000000.
Código hexadecimal da cor de texto no botão.
Ex: #ffffff.
Arredondamento dos cantos no botão em pixels.
Ex: 10px.
É possível personalizar a tela de contextualização que é apresentada para o usuário final no início da jornada, conforma imagem abaixo:
Nesta seção, você encontrará todos os cenários de response do by Unico, independentemente se os processos estão finalizados ou não
Ocorre quando o processo foi criado, porém ainda não foi finalizado pelo usuário.
| state | result |
|---|
Ocorre quando o processo foi criado, porém houve algum erro no serviço.
Ocorre quando o processo foi criado, finalizado pelo usuário e teve retorno POSITIVO do IDUnico.
Ocorre quando o processo foi criado, finalizado pelo usuário, mas teve retorno INCONCLUSIVO do IDUnico.
Ocorre quando o processo foi criado, finalizado pelo usuário, mas teve retorno de falha na prova de vida.
Ocorre quando o processo foi criado, porém ainda não foi finalizado pelo usuário.
Ocorre quando o processo foi criado, porém houve algum erro no serviço.
Ocorre quando o processo foi criado, finalizado pelo usuário e teve retorno POSITIVO do IDUnico.
GetProcess
Ocorre quando o processo foi criado, finalizado pelo usuário, teve retorno INCONCLUSIVO do IDUnico e gerou uma divergência no IDCheck, que por sua vez demorou mais do que 60s para ser resolvida pelos motores de divergência.
Ocorre quando o processo foi criado, finalizado pelo usuário, porém não foi possível validar que usuário que capturou a face estava ao vivo no momento da captura.
Nesta seção, você encontrará como informações de como implementar a abertura do by Unico através de um iFrame em jornadas Web
O iFrame é amplamente utilizado em cenários web. Para utilizar o by Unico por meio de um iFrame, o primeiro passo é cadastrar os domínios que serão utilizados como host para exibir o iFrame da jornada do usuário no by Unico.
Sinalize o responsável pelo seu projeto de integração ou o time de suporte da Unico para realizar essa configuração.
Para iniciar o uso do iFrame, devemos iniciar com a instalação da SDK web da Unico. O by Unico utiliza o mesmo SDK utilizado para o IDPay:
Esse método inicializa o SDK, fazendo um pré-carregamento de assets, criando a experiência mais fluida para o usuário final. Nesse momento é preciso enviar o token recebido como resultado do CreateProcess.
Parâmetros:
options - é um objeto com as seguintes propriedades de configuração:
type
O tipo de fluxo que será inicializado. No by Unico utilizamos a opção "IFRAME".
token
Recebe o token do processo criado. Esse token é importante para conseguirmos autenticar a jornada e garantir que somente domínios autorizados utilizem-na (pode ser obtido na criação do processo via API).
Esse método realiza a abertura da experiência do by Unico. Para o fluxo do tipo IFRAME, essa função exibe o iframe já pré-carregado, e inicia o fluxo de mensageria entre a página do cliente e a experiência do by Unico.
Parâmetros:
options - é um objeto com propriedades de configuração:
processId
Recebe o ID do processo criado. Esse ID é importante para conseguirmos obter os detalhes do processo e realizarmos todo o fluxo da maneira correta (pode ser obtido na criação do processo via API).
token
Recebe o token do processo criado. Esse token é importante para conseguirmos autenticar a jornada e garantir que somente domínios autorizados utilizem-na (pode ser obtido na criação do processo via API).
onFinish(process)
Recebe uma função de callback que será executada no término da jornada do by Unico, passando como argumento o objeto do processo com os seguintes dados: { captureConcluded, concluded, id }
O diagrama de sequência abaixo demonstra como utilizar o SDK e o resultado da API do by Unico para configurar o iFrame:
Os domínios dinâmicos representam um risco substancial para a segurança ao usar CSP. Quando um cliente possui domínios que mudam com frequência ou são criados dinamicamente, seria necessário atualizar constantemente a política CSP para incluir esses novos domínios. Isso não só aumenta o esforço de manutenção, mas também expõe os domínios aos quais a política CSP se aplica. Cada domínio adicionado à política CSP é potencialmente um ponto de vulnerabilidade se não for adequadamente gerenciado.
Para mitigar esses riscos e atender à flexibilidade exigida pelos nossos clientes, optamos por utilizar iframes combinados com tokens de autenticação. Esta solução oferece uma camada adicional de segurança e evita a necessidade de expor ou gerenciar uma lista extensa e dinâmica de domínios.
Autenticação Segura: Cada iframe é carregado com um token de autenticação exclusivo para cada transação, garantindo que apenas usuários autorizados possam acessar o conteúdo. Esse token é verificado em tempo real, proporcionando uma camada adicional de segurança e controle.
Isolamento de Conteúdo: O uso de iframes permite isolar o conteúdo em um contexto separado, reduzindo o risco de interferência entre diferentes origens e mitigando potenciais ataques.
Flexibilidade para Domínios Dinâmicos: Ao não depender de uma política CSP estática, nossa solução se adapta facilmente aos domínios dinâmicos dos clientes, sem a necessidade de atualização constante das políticas de segurança.
Nesta seção, você encontrará a especificação de todos os parâmetros da API REST do meio de integração by Unico
| code | message | Descrição |
|---|---|---|
| message | Descrição |
|---|---|
| code | message | Descrição |
|---|---|---|
| sucess | message | data | Descrição |
|---|---|---|---|
| code | message | Descrição |
|---|---|---|
| message | Descrição |
|---|---|
| code | message | Descrição |
|---|---|---|
| code | message | Descrição |
|---|---|---|
| code | message | Descrição |
|---|---|---|
| code | message | Descrição |
|---|---|---|
| message | Descrição |
|---|---|
| code | message | Descrição |
|---|---|---|
| code | message | Descrição |
|---|---|---|
| Message | StatusCode | Errors |
|---|---|---|
| sucess | message | data | Descrição |
|---|---|---|---|
Ex: .
Para personalizar as informações na tela de contextualização, você deve alterar os valores dos parâmetros contidos no objeto contexualization, no momento de realizar a chamada . O trecho na requisição que deve ser alterado é o seguinte:
Para saber detalhadamente o que significa cada parâmetro, não deixe de consultar a seção correspondente .
Dúvidas?
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da .
| state | result |
|---|
| state | result |
|---|
| state | result |
|---|
| state | result |
|---|
| state | result |
|---|
| state | result |
|---|
| state | result |
|---|
Ocorre quando o processo foi criado, finalizado pelo usuário, teve retorno INCONCLUSIVO do IDUnico e teve um Score válido no IDCheck.
| state | result |
|---|
| state | result |
|---|
| state | result |
|---|
Para verificar detalhadamente os parâmetros da API, consulte a seção .
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da .
Após uma análise cuidadosa das necessidades e desafios que enfrentamos, decidimos adotar uma solução baseada em iframes com tokens de autenticação ao invés de implementar uma política de Content Security Policy (CSP). Essa escolha foi motivada por diversas considerações relacionadas à segurança e à flexibilidade necessárias para atender às demandas dos nossos clientes.
O Content Security Policy (CSP) é uma ferramenta poderosa para proteger aplicações web contra diversos tipos de ataques, como Cross-Site Scripting (XSS) e injeção de código. No entanto, ao configurar uma política CSP, é necessário definir uma lista rígida de domínios confiáveis. Essa abordagem é eficaz quando os domínios são fixos e previsíveis. No entanto, para nossos clientes, que frequentemente utilizam domínios dinâmicos e variáveis, essa configuração rígida apresenta desafios significativos.
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da .
| Nome | Tipo | Descrição |
|---|
| Nome | Tipo | Descrição |
|---|
| Nome | Tipo | Descrição |
|---|
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da .
3
invalid flow
Quando o flow específicado não existe.
3
invalid purpose
Quando a proposta informada não é valida.
3
invalid callbackUri: unable to parse callbackUri: parse "": empty url, invalid callbackUri: url:
Quando o callbackUri informado não é válido.
3
invalid person: email required for notification channel NOTIFICATION_CHANNEL_EMAIL, invalid email address for notification channel NOTIFICATION_CHANNEL_EMAIL
Quando o e-mail informado não é válido, mas há a notificação via e-mail.
3
invalid person: phone number required for notification channel NOTIFICATION_CHANNEL_WHATSAPP, phone number does not contain 13 chars for notification channel NOTIFICATION_CHANNEL_WHATSAPP
Quando o telefone informado não é válido, mas há a notificação via SMS ou WhatsApp.
3
idnsv2/GetPublicID request error: rpc error: code = InvalidArgument desc = invalid dui value
Quando o CPF informado não é válido.
9
XX ID Apikeys are not set
Quando alguma API Key não foi configurada corretamente.
Jwt header is an invalid JSON
Quando o access-token utilizado contém caracteres errados.
Jwt is expired
Quando o access-token utilizado expirou
99999
Internal failure! Try again later
Quando há algum erro interno.
false
Falha ao consultar o arquivo do documento.
Documento não existe.
O id do documento informado não existe
3
process id is invalid
Quando o id de processo é inválido.
Jwt header is an invalid JSON
Quando o access-token utilizado contém caracteres errados.
Jwt is expired
Quando o access-token utilizado expirou
7
no permission
Quando a conta de serviço não possui a permissão para obter a selfie
5
error getting process: rpc error: code = NotFound desc = process not found
Quando o id do processo não foi encontrado
99999
Internal failure! Try again later
Quando há algum erro interno.
3
process id is invalid
Quando o id de processo é inválido.
Jwt header is an invalid JSON
Quando o access-token utilizado contém caracteres errados.
Jwt is expired
Quando o access-token utilizado expirou
5
error getting process: rpc error: code = NotFound desc = process not found
Quando o id do processo não foi encontrado
99999
Internal failure! Try again later
Quando há algum erro interno.
Not Found - Documento não existe
404
null
false
Falha ao consultar o arquivo do documento.
Documento não existe.
O id do documento informado não existe
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| string | O identificador do processo. |
| string | Indica a jornada que foi criada.
|
| string | Indica para onde o usuário será redirecionado no fim do processo. |
| string | Indica a URL para onde você deverá redirecionar o usuário para finalização da jornada. |
| string | Indica o estado atual do processo, por ser do tipo:
|
| string | Indica o resultado do processo da jornada do usuário, podendo ser do tipo:
|
| string | Sinaliza o momento em que o processo foi criado. |
| string | Sinaliza o momento em que o processo foi finalizado. |
| string | Indica o tipo de identificador do usuário.
|
| string | Indica o valor do identificador do usuário especificado no campo |
| string | Indica o valor e-mail do usuário especificado no campo |
| string | Indica o valor telefone do usuário especificado no campo |
| string | Indica o nome do usuário, por exemplo, |
| string | Indica qual foi o canal do envio das notificações na criação do processo. |
| string | Indica qual foi o propósito da coleta de dados do usuário no momento que o processo foi criado. |
| string | Indica o resultado da validação de identidade pela capacidade Verificação de Identidade.
|
| string | Indica se a capacidade Score de risco está habilitada nesta jornada. |
| integer | Indica o Score de risco para os casos onde a resposta da Verificação de Identidade foi inconclusiva. |
| string | Indica o id do processo que derivou para Score de risco. Pode ser utilizado no flow idtoken, como um valor do parâmetro |
| string | Indica o resultado do liveness.
|
| integer | Indica o resultado do score de similaridade da serpro. Atualmente só disponível para o flow |
| boolean | Sinaliza se houve ( Um documento é reaproveitado quando já existe na base da dados da Unico e o usuário deu permissão para reutilizá-lo sem a necessidade de uma nova captura. |
| boolean | Sinaliza se o CPF da requisição é o mesmo do documento. Se sim ( |
| boolean | Sinaliza se houve ( Um documento é tipificado quando é possível identificar o seu layout. |
| string | Identificador único do documento compartilhado. |
| string | Sinaliza a URL assinada do documento. |
| boolean | Sinaliza se houve ( |
| boolean | Sinaliza se o a pessoa da foto da requisição é o mesma do documento. Se sim ( |
| integer | Sinaliza a versão do documento. |
| object | Quando tipificado o documento retornará os dados extraídos do documento:
|
| string | Quando tipificado retornará RG, CIN ou CNH, quando não “Desconhecido"
|
| boolean | Sinaliza se houve ( |
| string | Indica o identificador do envelope da Assinatura eletrônica. |
| string | Indica o identificador do documento que foi assinado na jornada. |
| string | Indica quais capacidades IDCloud foram utilizadas no respectivo flow do processo. Pode ter os seguintes retornos:
|
| string | Sinaliza o momento em que o processo será/foi expirado, o valor desse campo é calculado a partir do campo |
| string | O É um string codificado em Base64 que deve ser convertido para um arquivo de imagem em sua aplicação. |
| string | Indica que conteúdo em fileContents é uma imagem jpeg ou png. |
| string | É um string codificado em Base64 que deve ser convertido para um arquivo PDF em sua aplicação |
| string | Indica que conteúdo em fileContents é um pdf. |
|
|
| string | Obrigatório | Define a jornada que a ser executada.
|
| string | Obrigatório |
| string | Obrigatório | Define o tipo de identificador do usuário.
|
| string | Obrigatório | Define o valor do identificador do usuário especificado no campo personDuiType.
Exemplo: No caso de uso do identificador |
| string | Opcional | Define o nome do usuário. Ex.: |
| string | Opcional(*) | Define o telefone do usuário. Ex.: |
| string | Opcional(*) | Define o email do usuário. |
| string | Opcional |
|
| string | Obrigatório | Define o propósito de uso e coleta de dados do usuário. Tem como objetivo dar transparência e garantir o tratamento de dados correto pela LGPD.
|
| string | Opcional(**) | Define o Id da transação que deseja comparar com a validação do fluxo |
| array | Obrigatório | O campo |
| string | Opcional | Esse campo define o tempo em segundos para a expiração do processo, baseado na data do created_at. Por exemplo, para a expiração ocorrer daqui 7 dias é necessário informar como |
| float | Opcional | Esse campo define o valor que será exibido na contextualização do processo. |
| string | Opcional(***) | Esse campo define a moeda que será usada para formatação do campo |
| string | Opcional | Esse campo define a informação que será exibida no campo de |
| string | Opcional | Esse campo define a informação que será exibida no campo de |
| string | Opcional | Esse campo define a informação que será exibida no campo de |
Define para onde o usuário será redirecionado ao fim do processo.
URL: Você pode utilizar uma URL para uma página web de seu fluxo. Exemplo: https://developers.unico.io/callback. Você pode personalizar como desejar.
URL Scheme: Você também pode realizar o redirecionamento para aplicações móveis nativas. Exemplo: br.com.meupacote.app://callback. Esse callback precisa estar registrado em sua aplicação móvel.
Sem redirecionamento: Caso você esteja usando a solução em um fluxo de mensagem, utilize o valor / para evitar um redirecionamento ao final do fluxo.
Para saber mais sobre como redirecionar o usuário, veja a seção
Endpoint para buscar o documento assinado em PDF. Somente para fluxos com assinatura eletrônica.
ID do documento.
Documento assinado obtido com sucesso.
Arquivo PDF gerado pelo sistema.
Endpoint para buscar o conjunto probatório do processo de verificação de identidade no by Unico.
ID do processo.
Conjunto probatório obtido com sucesso.
Conteúdo probatório codificado em base64.
"JVBERi0xLjUNCiWDk[...]NCg=="Tipo do conteúdo das evidências (PDF).
"x-pdf"Endpoint para buscar o conjunto probatório da assinatura. Somente para fluxos com assinatura eletrônica.
ID do documento.
Conjunto probatório obtido com sucesso.
Arquivo PDF gerado pelo sistema.
Endpoint para buscar a selfie do processo do by Unico. O parâmetro opcional raw=true pode ser utilizado para obter o arquivo bruto.
ID do processo.
Flag opcional para retornar o arquivo bruto da selfie.
trueSelfie obtida com sucesso.
Conteúdo da selfie codificado em base64.
"/9j/4AAQSkZJRgABAQA[...]QkeQUjE"Tipo do conteúdo da imagem (jpeg ou png).
"image/jpeg"Endpoint para criar um novo processo de verificação de identidade no by Unico.
Define para onde o usuário será redirecionado ao fim do processo. Valores possíveis são: Uma URL https para redirecionar páginas web, uma URL Schema para redirecionamento em aplicações móveis nativas ou sem redireciomento (incluir apenas a '/').
"/"Tipo de fluxo. Fluxos possíveis: 'idlive', 'idcheck', 'iddocs', 'idsign', 'iddocssign', 'idcheckserpro', 'idtoken'. Veja detalhes dos fluxos na seção 'Visão Geral' nesta mesma documentação.
"iddocssign"É o ID da filial onde o processo será criado. Caso haja somente uma filial associada a conta de serviço, não há a necessidade de passar este parâmetro.
"60837cd3-ed3c-4038-ad7c-0a85ad64b03a"Identificação do token biométrico. Obrigatório para o flow "idtoken" e deve-se utilizar um id de um processo concluído de qualquer outro flow de verificação de identidade.
"60837cd3-ed3c-4038-ad7c-0a85ad64b03a"Tipo de documento de identificação. Deve-se utilizar "DUI_TYPE_BR_CPF" ter o CPF como identificador.
"DUI_TYPE_BR_CPF"Valor do documento de identificação (ex: número do CPF).
"12345678909"Nome da pessoa.
"Luke Skywalker"Número de telefone da pessoa. Torna-se obrigatório caso envie a notificação via SMS ou WhatsApp.
"5511912345678"E-mail da pessoa. Torna-se obrigatório caso envie a notificação via E-mail.
"teste@teste.com"Canal de notificação. Pode receber os valores - NOTIFICATION_CHANNEL_WHATSAPP, NOTIFICATION_CHANNEL_SMS e NOTIFICATION_CHANNEL_EMAIL (também é possível enviar as notificações em mais de um lugar, basta informar mais de um.)
"NOTIFICATION_CHANNEL_WHATSAPP"Propósito do processo. Pode receber os valores: 'creditprocess', 'biometryonboarding' ou 'carpurchase'.
"creditprocess"É o tempo de expiração do processo em segundos. Caso essa informação não seja informada, será usado o valor default de 7 dias.
"3600s"Nome do documento. Torna-se obrigatório caso utilize algum flow com assinatura eletrônica.
"teste"Documento que deve ser assinado em base64. Torna-se obrigatório caso utilize algum flow com assinatura eletrônica.
"JVBERi0xLjMNCiXi48/[...]DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg=="Processo criado com sucesso.
ID do processo.
"53060f52-f146-4c12-a234-5bb5031f6f5b"É o ID da filial onde o processo foi criado. Caso não tenha sido passado nenhum valor de companyBranchId, este parêmtro não irá retornar no response.
"60837cd3-ed3c-4038-ad7c-0a85ad64b03a"Fluxo escolhido.
"iddocssign"URI de callback.
"/path/to/callback-url/"URL que o usuário fará a jornada.
"https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b"Estado do processo.
"PROCESS_STATE_CREATED"Tipo de documento de identificação.
"DUI_TYPE_BR_CPF"Valor do documento de identificação.
"73689290074"Nome da pessoa.
"Luke Skywalker"Número de telefone da pessoa.
"5511912345678"E-mail da pessoa.
"teste@teste.com"Canal de notificação.
"NOTIFICATION_CHANNEL_WHATSAPP"Propósito do processo.
"creditprocess"Informações da autenticação. Será sempre vazio na criação do processo.
Capacidades do processo.
Data de expiração do processo.
"2023-10-09T15:15:25.417105Z"Token assinado que contém os parâmetros necessários para inicializar o SDK web do by Unico, permitindo integração via iFrame.
"eyJhbGciOiJSUzI1[...]d_jhQ"Endpoint para buscar o resultado de um processo de verificação de identidade no by Unico.
ID do processo.
Detalhes do processo obtidos com sucesso.
ID do processo.
"53060f52-f146-4c12-a234-5bb5031f6f5b"Fluxo utilizado no processo.
"iddocssign"É o ID da filial onde o processo foi criado. Caso não tenha sido passado nenhum valor de companyBranchId, este parâmetro não irá retornar no response.
"60837cd3-ed3c-4038-ad7c-0a85ad64b03a"URI de callback.
"/path/to/callback-url/"URL de redirecionamento do usuário.
"https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b"Estado do processo.
"PROCESS_STATE_FINISHED"Resultado do processo.
"PROCESS_RESULT_OK"Tipo de documento de identificação.
"DUI_TYPE_BR_CPF"Valor do documento de identificação.
73689290074Nome da pessoa.
"Luke Skywalker"Canal de notificação.
"NOTIFICATION_CHANNEL_WHATSAPP"Propósito do processo.
"creditprocess"Resultado da autenticação.
"AUTHENTICATION_RESULT_INCONCLUSIVE"Indica se o score está habilitado.
"SCORE_ENABLED_TRUE"Score obtido no processo.
50ID da autenticação.
"fd433602-d496-4291-adbb-dda95a3e50b1"Resultado do teste de liveness.
"LIVENESS_RESULT_LIVE"Capacidades do processo.
Versão do documento.
2Código do documento.
"RG"Data de expiração do documento.
"2025-10-35T00:00:00Z"Data de habilitação do documento.
"2022-08-09T00:00:00Z"Data de nascimento da pessoa.
"1950-06-30T00:00:00Z"Nome civil da pessoa.
"John Doe"Número do RG.
5478854Categoria.
"D"Número do CPF.
73689290074Data de emissão do documento.
"2020-08-09T00:00:00Z"Local de emissão do documento.
"DEREX SP"Número do documento.
85775532778Número do RENACH.
""Indica se o documento foi tipificado.
trueIndica se o CPF confere com o documento.
trueIndica se o rosto confere com o documento.
trueID do documento.
"1e61a978-3673-4fdd-8fa8-808d0a26d131"Indica se o documento foi validado.
trueIndica se o documento foi reutilizado.
trueURL assinada para o documento.
"https://api.datafortress.dev.private.unico.run/url-signer/signature/dmF1bHQ6[...]OXc9PQ%3D%3D"Indica se o consentimento foi concedido.
trueID do envelope de documentos.
"4d4f3d90-04a3-4259-b63b-930ab10d2e47"IDs dos documentos.
Data de criação do processo.
"2023-10-05T18:28:58.537985Z"Data de finalização do processo.
"2023-10-09T15:15:25.417105Z"Data de expiração do processo.
"2023-10-09T15:15:25.417105Z"