Página inicialAutenticação

Prova de vida

Nesta seção, você encontrará as particularidades de criar um processo que tenha somente a Prova de vida como capacidade

Introdução

Nesta seção, você encontrará a documentação detalhada sobre o funcionamento do endpoint relacionado à capacidade Prova de vida, utilizada de forma isolada.

Trata-se de uma capacidade síncrona, 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 exclusivamente para a capacidade Prova de Vida, 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:

Criação do Processo

Criar Processo

post

Endpoint para criar um novo processo de prova de vida isolada no by Client.

Parâmetros de cabeçalho
AuthorizationstringObrigatório

Access-token válido.

APIKEYstringObrigatório

APIKEY válida com a capacidade prova de vida habilitada.

Corpo
subsidiaryIdstringOpcional

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
imageBase64stringObrigatório

Arquivo encrypted gerado pelo SDK.

Example: /9j/4AAQSkZJR...
Respostas
200
Processo criado com sucesso (Usuário ao vivo).
application/json
post
POST /processes/v1 HTTP/1.1
Host: api.id.uat.unico.app
Authorization: text
APIKEY: text
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "subject": {
    "code": "12345678909",
    "name": "Luke Skywalker",
    "email": "[email protected]",
    "phone": "551972557070"
  },
  "subsidiaryId": "35d734c4-7fbb-4b2f-a1dc-7e1575514819",
  "imageBase64": "/9j/4AAQSkZJR..."
}
{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "liveness": 1
}

Pontos Importantes:

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

  • Caso ocorra algum erro no processamento da biometria, a requisição retornará um status code = 200 e 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 implementar suas regras de negócio, sempre valide os status finais dos processos (3,5). Para validar a resposta das capacidades IDCloud, só considere o status = 3 para sua tomada de decisão;

  • Para mais informações sobre os cenários que pode receber no response, consulte a seção Cenários de response;

  • 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.

Atualizado

Isto foi útil?