Skip to main content

Response scenarios

This article exemplifies the possible response scenarios of the CreateProcess and GetProcess methods for the Synchronous Key API. For more information read the article Biometric Analysis.

IDUnico + IDCheck​

Scenario: Process not completed​

Occurs when IDUnico is still processing the transaction (asynchronous API only)

CreateProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 1
}
GetProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 1
}

Scenario: YES result from IDUnico​

Occurs when IDUnico returns 100% certainty that the biometric is of the real CPF holder.

CreateProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 3,
    "unicoId": {
        "result": "yes"
    }
}
GetProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 3,
    "unicoId": {
        "result": "yes"
    }
}

Scenario: INCONCLUSIVE IDUnico Result and Reproved Liveness​

Occurs when IDUnico is unable to validate the CPF ownership because the proof of life has been rejected.

CreateProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 3,
    "unicoId": {
        "result": "inconclusive"
    },
    "liveness": 2
}
GetProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 3,
    "unicoId": {
        "result": "inconclusive"
    },
    "liveness": 2
}

Scenario: INCONCLUSIVE IDUnico Result, Approved Liveness and IDCheck Score​

This occurs when IDUnico is unable to validate with 100% certainty that the biometric is the CPF holder's, but the person is live. In this way, IDCheck returns the probability score of that person being the CPF holder.

CreateProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 1,
    "unicoId": {
        "result": "inconclusive"
    },
    "liveness": 1
}
GetProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 3,
    "unicoId": {
        "result": "inconclusive"
    },
    "liveness": 1,
    "score": 10
}

Scenario: INCONCLUSIVE IDUnico Result, Approved Liveness and IDCheck Divergence​

Occurs when IDUnico is unable to validate with 100% certainty that the biometrics belong to the CPF holder, the person is live, but IDCheck has returned a discrepancy as to the real ownership of the CPF (getProcess must be carried out to obtain the score back asynchronously).

*Note: This is not the final status of the process.

CreateProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 1,
    "unicoId": {
        "result": "inconclusive"
    },
    "liveness": 1
}
GetProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 2,
    "unicoId": {
        "result": "inconclusive"
    },
    "liveness": 1
}

Scenario: INCONCLUSIVE IDUnico Result, Approved Liveness and IDCheck Drop​

This occurs when IDUnico is unable to validate with 100% certainty that the biometrics belong to the CPF holder, the person is live, but IDCheck was unable to process the authentication score (it's a drop in the check).

CreateProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 3,
    "unicoId": {
        "result": "inconclusive"
    },
    "liveness": 1
}
GetProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 3,
    "unicoId": {
        "result": "inconclusive"
    },
    "liveness": 1
}

Scenario: Process with error​

Occurs when there is an error in the transaction and the registration could not be processed.

CreateProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 5
}
GetProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 5
}

IDUnico​

Scenario: Process not finished​

Occurs when IDUnico is still processing the transaction (asynchronous API only).

CreateProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 1
}
GetProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 1
}

Scenario: YES result from IDUnico​

Occurs when IDUnico returns 100% certainty that the biometric is of the CPF holder.

CreateProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 3,
    "unicoId": {
        "result": "yes"
    }
}
GetProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 3,
    "unicoId": {
        "result": "yes"
    }
}

Scenario: INCONCLUSIVE IDUnico result and/or Reproved Liveness​

Occurs when IDUnico is unable to validate CPF ownership and/or the proof of life has been rejected.

CreateProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 3,
    "unicoId": {
        "result": "inconclusive"
    },
}
GetProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 3,
    "unicoId": {
        "result": "inconclusive"
    },
}

Scenario: Process with error​

Occurs when there is an error in the transaction and the registration could not be processed.

CreateProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 5
}
GetProcess
{
    "id": "fc7219f8-ee00-4489-8427-910b0cceffdd",
    "status": 5
}

Any concerns?​

Missing something or still need help? If you are already a customer or partner, you can contact us through the Help Center.