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;

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

---

Criação do Processo

---

Criar Processo

post

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

Header parameters

Authorizationstringrequired

Access-token válido.

APIKEYstringrequired

APIKEY válida com as capacidades prova de vida + validação 1:1 habilitadas.

Body

subjectobjectrequired

Informações do usuário.

referenceProcessIdstringrequired

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

subsidiaryIdstringoptional

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

imageBase64stringrequired

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

Example: /9j/4AAQSkZJR...

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.id.uat.unico.app/processes/v1' \
  --header 'Authorization: text' \
  --header 'APIKEY: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "subject": {
      "code": "12345678909",
      "name": "Luke Skywalker",
      "email": "[e-mail]",
      "phone": "551972557070"
    },
    "referenceProcessId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
    "subsidiaryId": "35d734c4-7fbb-4b2f-a1dc-7e1575514819",
    "imageBase64": "/9j/4AAQSkZJR..."
  }'

200

400

500

200

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

Processo criado com sucesso (Usuário autenticado).

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, não devolveremos o parâmetro liveness no response da API. Neste cenário não há nenhuma validação da prova de vida, nem mesmo passiva.

• Caso ocorra algum erro no processamento, o processo retornará um status = 5, como no exemplo abaixo:

    {
    "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
    "status": 5
    }

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.