1 de 2

GetEvidenceSet

Nesta seção, você encontrará como obter o conjunto probatório de um processo no by Unico através da API REST

Antes de começar

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.

Endpoints:

UAT: https://api.cadastro.uat.unico.app/client/v1/process;
Produção: https://api.cadastro.unico.app/client/v1/process.

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.

Responses de erro

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.

Especificação do conjunto probatório

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:

Campos do Conjunto Probatório (clique em cada um para saber mais)

Usuário

Foto com marca d'água;
Nome - indica o nome da pessoa autenticada. Esse dado é obtido através do parâmetro person.friendly_name do CreateProcess;
CPF do titular - indica o CPF da pessoa autenticada. Esse dado é obtido através do parâmetro person.dui_value do CreateProcess;
Canal de contato - indica o canal de comunicação com a pessoa autenticada. Esse dado é obtido através do parâmetro person.notifications do CreateProcess.

Processo

Fluxo executado - indica qual fluxo foi executado. Esse dado é obtido através do parâmetro flow do CreateProcess;
Identificador do processo - indica o id do processo. Esse dado é obtido através do parâmetro procees.id no retorno do CreateProcess;
URL - indica a URL de autenticação do processo;
Criação - indica a data da criação do processo. Esse dado é obtido através do parâmetro createdAt no retorno do CreateProcess;
Finalização - indica a data de finalização do processo. Esse dado é obtido através do parâmetro finishedAt no retorno do CreateProcess;
Estado - indica o status do processo. Esse dado é obtido através do parâmetro state no retorno do CreateProces;
Empresa - indica a empresa.

Validações

Tipo de validação - indica o tipo de validação da autenticação do processo;
Identidade - indica resultado da Verificação de Identidade;
Detecção de vida - indica resultado da Prova de vida.

Dados de navegação

Sistema operacional e navegador - indica os dados do dispositivo;
Endereço do IP - indica o IP do dispositivo.

Evidências de uso dos módulos nos flows iddocs, idsign e iddocssign

Quando o processo envolve os fluxos de IDDocs e Sign, o conjunto probatório também retorna dados desses fluxos como:

Documentos:

Tipo de documento - identifica o documento compartilhado pela pessoa. Ex: CNH / RG;
Modulo de coleta - caso Sim, identifica se houve a captura de um documento;
Documento validado - caso Sim, identifica que o documento compartilhado/reutilizado foi validado.

Assinatura:

Dados do Envelope - indica os documentos e seus assinantes;
ID do envelope - UUID que identifica o envelope no Unico Sign

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.

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.

GetEvidenceSet

Nesta seção, você encontrará como obter o conjunto probatório de um processo no by Unico através da API REST

Antes de começar

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.

Endpoints:

UAT: https://api.cadastro.uat.unico.app/client/v1/process;
Produção: https://api.cadastro.unico.app/client/v1/process.

GetEvidenceSet

Endpoint para buscar o conjunto probatório do processo de verificação de identidade no by Unico.

GEThttps://api.cadastro.uat.unico.app/client/v1/process/{id}/evidenceset

Authorization

Path parameters

id*string

ID do processo.

Response

Conjunto probatório obtido com sucesso.

Body

fileContentsstring

Conteúdo probatório codificado em base64.

Example: "JVBERi0xLjUNCiWDk[...]NCg=="

contentTypestring

Tipo do conteúdo das evidências (PDF).

Example: "x-pdf"

Request

Response

Para verificar detalhadamente os parâmetros da API, consulte a seção Especificação de parâmetros.

Responses de erro

code

message

Descrição

message

Descrição

code

message

Descrição

code

message

Descrição

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.

Especificação do conjunto probatório

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:

Campos do Conjunto Probatório (clique em cada um para saber mais)

Usuário

Foto com marca d'água;
Nome - indica o nome da pessoa autenticada. Esse dado é obtido através do parâmetro person.friendly_name do CreateProcess;
CPF do titular - indica o CPF da pessoa autenticada. Esse dado é obtido através do parâmetro person.dui_value do CreateProcess;
Canal de contato - indica o canal de comunicação com a pessoa autenticada. Esse dado é obtido através do parâmetro person.notifications do CreateProcess.

Processo

Fluxo executado - indica qual fluxo foi executado. Esse dado é obtido através do parâmetro flow do CreateProcess;
Identificador do processo - indica o id do processo. Esse dado é obtido através do parâmetro procees.id no retorno do CreateProcess;
URL - indica a URL de autenticação do processo;
Criação - indica a data da criação do processo. Esse dado é obtido através do parâmetro createdAt no retorno do CreateProcess;
Finalização - indica a data de finalização do processo. Esse dado é obtido através do parâmetro finishedAt no retorno do CreateProcess;
Estado - indica o status do processo. Esse dado é obtido através do parâmetro state no retorno do CreateProces;
Empresa - indica a empresa.

Validações

Tipo de validação - indica o tipo de validação da autenticação do processo;
Identidade - indica resultado da Verificação de Identidade;
Detecção de vida - indica resultado da Prova de vida.

Dados de navegação

Sistema operacional e navegador - indica os dados do dispositivo;
Endereço do IP - indica o IP do dispositivo.

Evidências de uso dos módulos nos flows iddocs, idsign e iddocssign

Quando o processo envolve os fluxos de IDDocs e Sign, o conjunto probatório também retorna dados desses fluxos como:

Documentos:

Tipo de documento - identifica o documento compartilhado pela pessoa. Ex: CNH / RG;
Modulo de coleta - caso Sim, identifica se houve a captura de um documento;
Documento validado - caso Sim, identifica que o documento compartilhado/reutilizado foi validado.

Assinatura:

Dados do Envelope - indica os documentos e seus assinantes;
ID do envelope - UUID que identifica o envelope no Unico Sign

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.

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.

GetEvidenceSet

Antes de começar

Endpoints:

Responses de erro

Dúvidas?​

Especificação do conjunto probatório

Campos do Conjunto Probatório (clique em cada um para saber mais)

Dúvidas?​

GetEvidenceSet

Antes de começar

Endpoints:

GetEvidenceSet

Responses de erro

Dúvidas?​

Especificação do conjunto probatório

Campos do Conjunto Probatório (clique em cada um para saber mais)

Dúvidas?​

GetEvidenceSet

Dúvidas?

Dúvidas?

Dúvidas?

Dúvidas?