Prova de vida + Validação (1:1)

Nesta seção, você encontrará as particularidades de criar um processo que tenha Prova de vida + Validação (1:1) como capacidades

---

Introdução

---

Nesta seção, você encontrará a documentação detalhada sobre o funcionamento do endpoint relacionado às capacidades Prova de Vida + Validação (1:1), utilizadas em conjunto.

Trata-se de duas capacidades síncronas, ou seja, toda a integração ocorre utilizando um único endpoint.

As capacidades da plataforma Unico IDCloud via by Client são gerenciadas por meio de API Keys - utilizadas como um parâmetro no header das requisições -, que definem o escopo de acesso. Como pré-requisito, é necessário possuir uma API Key configurada com as capacidades Prova de Vida + Validação (1:1), garantindo acesso dedicado e seguro ao recurso.

Fale com o responsável do seu projeto para obter a API Key com esta configuração.

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.id.uat.unico.app/processes/v1;

• Produção: https://api.id.unico.app/processes/v1.

---

Criação do Processo

---

Criar Processo

Endpoint para criar um novo processo de prova de vida + validação 1:1 no by Client.

POSThttps://api.id.uat.unico.app/processes/v1/

Header parameters

Body

application/json

subject*object

Informações do usuário.

referenceProcessId*string

Identificador do processo que foi gerado durante a criação da transação biométrica, cuja foto será usada para comparação.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

subsidiaryIdstring

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. Caso haja separação de processos por filial, você receberá os IDs das filiais do time Unico.

Example: "35d734c4-7fbb-4b2f-a1dc-7e1575514819"

imageBase64*string

Arquivo encrypted gerado pelo SDK ou base64 (caso não utilize a Prova de vida).

Example: "/9j/4AAQSkZJR..."

Response

200400500

Processo criado com sucesso (Usuário autenticado).

Body

application/json

idstring

ID do processo.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

authenticatedboolean

Resultado da autenticação. Valores possíveis: 'true' - Sucesso. A face da transação é a mesma do processo de referência; 'false' - Falha. A face da transação não é a mesma do processo de referência.

Example: true

livenessenum

Resultado da prova de vida. Valores possíveis: '1' - Prova de vida aprovada; '2' - Prova de vida recusada.

Example: 1

12

Request

JavaScriptCurlPython

const response = await fetch('https://api.id.uat.unico.app/processes/v1/', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "APIKEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subject": {
        "code": "12345678909"
      },
      "referenceProcessId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
      "imageBase64": "/9j/4AAQSkZJR..."
    }),
});
const data = await response.json();

Response

200400500

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "authenticated": true,
  "liveness": 1
}

Pontos Importantes:

• Para utilizar a capacidade Prova de vida, é indispensável o uso dos nossos SDKs:

  • É possível utilizar a capacidade de Validação (1:1) sem a Prova de vida. Para este caso de uso o retorno de liveness sempre será liveness = 1. Neste cenário não há nenhuma validação da prova de vida, nem mesmo passiva.

Dicas:

• Para este caso de uso, não há a necessidade de Consultar o Resultado do Processo, visto que a resposta é síncrona;

• Para mais informações sobre os erros possíveis para este endpoint, consulte a seção Erros.

---

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.