HomepageAuthentication

Response Scenarios

In this section, you will find the possible responses for the combinations of capabilities separated by their methods to facilitate your understanding of the by Client integration

Understanding how the return of each parameter works is essential for implementing the best decision-making. To see in detail the meaning of each parameter, see the section Parameter Specification

In all the combinations described below, if an error occurs during processing, the process will return a status = 5. For this reason, the scenarios below do not display responses related to this condition. Example:

  {
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 5 //indicates that there was an error in the process
  }

Liveness

Liveness

Response CreateProcess

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

Response GetProcess

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

Response CreateProcess

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

Response GetProcess

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

For the scenarios where the response in CreateProcess is the same as the response from GetProcess, optimize your application and make your decision synchronously.

Liveness + Identity Verification

Liveness + Identity Verification

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"
  }
}

Notes:

  • The "yes" response from unicoId.result (identity verification) already includes the validation of the Liveness capability. That is, if the response is "yes," it is understood that the user's face matches that of the CPF holder AND that the user was live at the time the selfie was taken.

Liveness + Identity Verification ❔

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
}
Liveness + Identity Verification

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"
  }
}
Liveness + Identity Verification ❔

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
}
Liveness + Identity Verification

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"
  }
}

For the scenarios where the response in CreateProcess is the same as the response from GetProcess, optimize your application and make your decision synchronously.

Liveness + Identity Verification + Risk Score

Liveness + Identity Verification

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"
  }
}

Notes:

  • The "yes" response from unicoId.result (Identity Verification) already includes the validation of the Liveness capability. That is, if the response is "yes," it is understood that the user's face matches that of the CPF holder AND that the user was live at the time the selfie was taken;

  • When the response from unicoId.result (Identity Verification) is "yes," there will be no orchestration with the risk score capability.

Liveness + Identity Verification❔+ Risk Score

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
}

Notes:

  • If you perform the GetProcess and the process is not yet completed, we will return statuses 1 or 2. Only make your final decision when you obtain a status of process completion (status = 3). You can also use the webhook to be notified when the process is completed.

Liveness + Identity Verification❔+ Risk Score

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
}

Notes:

  • When the response from liveness is 2, there will be no orchestration with the Risk Score

Liveness + Identity Verification❔+ Risk Score

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
}

Notes:

  • When the status = 3 and the unicoId.result is "inconclusive," but we do not return the Risk Score, it is because there was an error (drop) in the biometric engine that could not generate the risk probability score.

Liveness + Identity Verification + Risk Score

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"
  }
}

Notes:

  • When the status = 3 and the unicoId.result is "no," there will be no orchestration with the Risk Score capability.

Liveness + Identity Verification + Risk Score

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"
  }
}

For the scenarios where the response in CreateProcess is the same as the responsefrom GetProcess, optimize your application and make your decision synchronously.

Still need help?​

Didn't find something or still need help? If you're already a client or partner, you can reach out through our Help Center.

PreviousErrorsNextAdditional Resources

Last updated

Was this helpful?