1 de 1

Cenários de response

Nesta seção, você encontrará os responses possíveis das combinações de capacidades separados por seus métodos, para facilitar seu entendimento sobre a integração by Client

Entender como funciona o retorno de cada parâmetro é fundamental para implementar a melhor tomada de decisão. Para ver detalhadamente o significado de cada parâmetro, veja a seção Especificação de parâmetros.

Em todas as combinações descritas a seguir, caso ocorra algum erro no processamento, o processo retornará um status = 5. Por esse motivo, os cenários abaixo não exibem responses referentes a essa condição. Exemplo:

  {
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 5 //indica que houve um erro no processo
  }

Prova de vida

Response CreateProcess

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

Response GetProcess

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

Prova de vida

Response CreateProcess

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

Response GetProcess

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

Para os cenários onde o response no CreateProcess é o mesmo que o response do GetProcess, otimize sua aplicação e tome sua decisão de forma síncrona.

Prova de vida + Verificação de Identidade

Para os cenários onde o response no CreateProcess é o mesmo que o response do GetProcess, otimize sua aplicação e tome sua decisão de forma síncrona.

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

Para os cenários onde o response no CreateProcess é o mesmo que o response do GetProcess, otimize sua aplicação e tome sua decisão de forma síncrona.

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.

Cenários de response

Nesta seção, você encontrará os responses possíveis das combinações de capacidades separados por seus métodos, para facilitar seu entendimento sobre a integração by Client

Entender como funciona o retorno de cada parâmetro é fundamental para implementar a melhor tomada de decisão. Para ver detalhadamente o significado de cada parâmetro, veja a seção Especificação de parâmetros.

  {
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 5 //indica que houve um erro no processo
  }

Prova de vida

Response CreateProcess

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

Response GetProcess

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

Prova de vida

Response CreateProcess

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

Response GetProcess

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

Para os cenários onde o response no CreateProcess é o mesmo que o response do GetProcess, otimize sua aplicação e tome sua decisão de forma síncrona.

Prova de vida + Verificação de Identidade

Response CreateProcess

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

Response GetProcess

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

Observações:

A resposta de "yes" do unicoId.result (verificação de identidade) já engloba a validação da capacidade Prova de vida, ou seja, se a resposta for "yes" entende-se que a face do usuário é a do titular do CPF E ele estava ao vivo no momento da captura da selfie.

Prova de vida + Verificação de Identidade ❔

Response CreateProcess

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

Response GetProcess

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

Prova de vida + Verificação de Identidade ❔

Response CreateProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 2
}

Response GetProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 2
}

Prova de vida + Verificação de Identidade

Response CreateProcess

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

Response GetProcess

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

Prova de vida + Verificação de Identidade

Response CreateProcess

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

Response GetProcess

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

Para os cenários onde o response no CreateProcess é o mesmo que o response do GetProcess, otimize sua aplicação e tome sua decisão de forma síncrona.

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

Prova de vida + Verificação de identidade

Response CreateProcess

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

Response GetProcess

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

Observações:

A resposta de "yes" do unicoId.result (Verificação de identidade) já engloba a validação da capacidade Prova de vida, ou seja, se a resposta for "yes" entende-se que a face do usuário é a do titular do CPF E ele estava ao vivo no momento da captura da selfie;
Quando a resposta do unicoId.result (Verificação de identidade) for "yes", não haverá a orquestração com a capacidade score de risco.

Prova de vida + Verificação de identidade❔+ Score de risco

Response CreateProcess

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

Response GetProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1,
  "score": 50
}

Observações:

Caso realize o GetProcess e o processo ainda não esteja concluído, retornaremos os status 1 ou 2. Só tome sua decisão final quando obtiver um status de conclusão do processo (status = 3). Você também pode utilizar o webhook para ser notificado quando o processo estiver concluído.

Prova de vida + Verificação de identidade❔+ Score de risco

Response CreateProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 2
}

Response GetProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 2
}

Observações:

Quando a resposta do liveness (Prova de vida) for 2, não haverá orquestração com o Score de risco.

Prova de vida + Verificação de identidade❔+ Score de risco

Response CreateProcess

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

Response GetProcess

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

Observações:

Quando o status = 3 e o unicoId.result for "inconclusive", mas não devolvermos o Score de risco, é porque houve um erro (drop) no motor de biométrica que não pôde gerar o score de probabilidade de risco.

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

Response CreateProcess

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

Response GetProcess

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

Observações:

Quando o status = 3 e o unicoId.result for "no" não haverá orquestração com a capacidade Score de risco.

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

Response CreateProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "no"
  },
  "liveness": 2
}

Response GetProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "no"
  },
  "liveness": 2
}

Para os cenários onde o response no CreateProcess é o mesmo que o response do GetProcess, otimize sua aplicação e tome sua decisão de forma síncrona.

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.

Prova de vida + Verificação de Identidade

Response CreateProcess

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

Response GetProcess

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

Observações:

A resposta de "yes" do unicoId.result (verificação de identidade) já engloba a validação da capacidade Prova de vida, ou seja, se a resposta for "yes" entende-se que a face do usuário é a do titular do CPF E ele estava ao vivo no momento da captura da selfie.

Prova de vida + Verificação de Identidade ❔

Response CreateProcess

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

Response GetProcess

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

Prova de vida + Verificação de Identidade ❔

Response CreateProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 2
}

Response GetProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 2
}

Prova de vida + Verificação de Identidade

Response CreateProcess

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

Response GetProcess

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

Prova de vida + Verificação de Identidade

Response CreateProcess

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

Response GetProcess

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

Prova de vida + Verificação de identidade

Response CreateProcess

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

Response GetProcess

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

Observações:

A resposta de "yes" do unicoId.result (Verificação de identidade) já engloba a validação da capacidade Prova de vida, ou seja, se a resposta for "yes" entende-se que a face do usuário é a do titular do CPF E ele estava ao vivo no momento da captura da selfie;
Quando a resposta do unicoId.result (Verificação de identidade) for "yes", não haverá a orquestração com a capacidade score de risco.

Prova de vida + Verificação de identidade❔+ Score de risco

Response CreateProcess

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

Response GetProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1,
  "score": 50
}

Observações:

Caso realize o GetProcess e o processo ainda não esteja concluído, retornaremos os status 1 ou 2. Só tome sua decisão final quando obtiver um status de conclusão do processo (status = 3). Você também pode utilizar o webhook para ser notificado quando o processo estiver concluído.

Prova de vida + Verificação de identidade❔+ Score de risco

Response CreateProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 2
}

Response GetProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 2
}

Observações:

Quando a resposta do liveness (Prova de vida) for 2, não haverá orquestração com o Score de risco.

Prova de vida + Verificação de identidade❔+ Score de risco

Response CreateProcess

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

Response GetProcess

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

Observações:

Quando o status = 3 e o unicoId.result for "inconclusive", mas não devolvermos o Score de risco, é porque houve um erro (drop) no motor de biométrica que não pôde gerar o score de probabilidade de risco.

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

Response CreateProcess

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

Response GetProcess

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

Observações:

Quando o status = 3 e o unicoId.result for "no" não haverá orquestração com a capacidade Score de risco.

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

Response CreateProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "no"
  },
  "liveness": 2
}

Response GetProcess

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "no"
  },
  "liveness": 2
}