Página inicialAutenticação

Prova de vida + Verificação de Identidade + Alerta de comportamento + Score de risco

Nesta seção, você encontrará as particularidades de criar um processo que tenha a Prova de vida + Verificação de Identidade + Alerta de comportamento + Score de risco como capacidades

A capacidade Score de Risco está em processo de descontinuação e, por isso, não recomendamos sua utilização. Para mais informações, entre em contato com o responsável pela sua conta.

Introdução

Nesta seção, você encontrará a documentação detalhada sobre o funcionamento dos endpoints relacionado às capacidades Prova de Vida + Verificação de Identidade + Alerta de comportamento + Score de risco, utilizadas em conjunto.

Trata-se de três capacidades síncronas (Prova de vida + Verificação de Identidade + Alerta de comportamento) integradas com uma capacidade assíncrona (Score de risco). Ou seja, para obter todas as respostas será necessário Consultar o Resultado do Processo.

Para essa integração, será necessário consumir dois endpoints descritos nesta documentação, que também podem ser combinados com o uso de Webhooks.

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 + Verificação de Identidade + Alerta de comportamento + Score de risco, 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 + verificação de identidade + alerta de comportamento + score de risco no by Client.

Parâmetros de cabeçalho
AuthorizationstringObrigatório

Access-token válido.

APIKEYstringObrigatório

APIKEY válida com as capacidades prova de vida + verificação de identidade + alerta de comportamento + score de risco habilitadas.

Corpo
useCasestringOpcional

Caso de uso da operação.

Example: Onboarding
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 ou base64 (caso não utilize a Prova de vida).

Example: /9j/4AAQSkZJR...
Respostas
200
Processo criado com sucesso.
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: 215

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

Pontos Importantes:

  • Caso a resposta da capacidade Verificação de Identidade seja unicoId = yes, este retorno já engloba a Prova de vida (ou seja, não receberá o parâmetro liveness no response);

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

    • É possível utilizar a capacidade de Verificação de Identidade 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.

  • Caso a resposta da capacidades Verificação de Identidade e Alerta de comportamento sejam unicoId = inconclusive + identityFraudsters = inconclusive, haverá a orquestração com a capacidade Score de risco. Caso alguma dessas respostas seja conclusiva, não haverá a orquestração com o Score de risco.

  • 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 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 erros possíveis para este endpoint, consulte a seção Erros.

Consulta do Resultado do Processo

Consultar Resultado do Processo

get

Endpoint para buscar o resultado de um processo de prova de vida + verificação de identidade + alerta de comportamento + score de risco no by Client.

Parâmetros de rota
processIdstringObrigatório

ID do processo.

Parâmetros de cabeçalho
AuthorizationstringObrigatório

Access-token válido.

APIKEYstringObrigatório

APIKEY válida com as capacidades prova de vida + verificação de identidade + alerta de comportamento + score de risco habilitadas.

Respostas
200
Informações do processo obtidas com sucesso.
application/json
get
GET /processes/v1/{processId} HTTP/1.1
Host: api.id.uat.unico.app
Authorization: text
APIKEY: text
Accept: */*

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "score": 50,
  "identityFraudsters": {
    "result": "inconclusive"
  },
  "liveness": 1
}

No endpoint da v2 (/processes/v2/{id}), também devolvemos algumas informações adicionais do usuário, conforme exemplo abaixo:

"processAdditionalInfo": {
      "transactionId": "2ed76ac5-8fd7-4477-839d-92bedd7e9fd5",
      "personName": "Nome da pessoa",
      "personDocument": "Número do documento da pessoa",
      "personImage": "URL assinada da imagem da pessoa",
      "finishedAt": "2024-10-04T18:53:17.028228"
  }
}

Atenção:

  • Quando a requisição GET for para um processo com status = 5 (erro), o status code de retorno é 410 (Gone) ao invés de 200 (Success);

  • Pode haver casos de drop na orquestração com a capacidade Score de risco. Neste cenário, o processo terá a combinação: {status = 3, unicoId = inconclusive, liveness = 1, identityFraudsters = inconclusive e SEM score no response da API}. Entenda mais na seção Cenários de response;

  • Caso consulte um processo que esteja no status = 2, implemente um polling até que obtenha um status = 3 ou implemente o Webhook da Unico para saber quando consultar o resultado.

Dicas:

  • Para implementar suas regras de negócio, sempre valide os status finais dos processos (3,4,5). Para validar a resposta das capacidades IDCloud, só considere o status = 3 para sua tomada de decisão;

  • Para melhorar a performance da sua operação, você pode utilizar nossos Webhooks e só consultar o resultado de processos que estiverem nos status finalizados;

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

AnteriorProva de vida + Verificação de Identidade + Alerta de comportamentoPróximoProva de vida + Validação 1:1 + Alerta de comportamento

Atualizado

Isto foi útil?