Get Process

URL Base:

• UAT: https://api.cadastro.uat.unico.app.

• Production: https://api.cadastro.unico.app.

Get Process Result

get

Endpoint to fetch the result of a process on by Unico.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

processIdstringRequired

Process ID.

Responses

200

Process details successfully obtained.

application/json

400

When the process ID is invalid.

application/json

401

Access-token error.

application/json

404

When the process could not be found.

application/json

get

/client/v1/process/{processId}

HTTPcURLJavaScriptPython

GET /client/v1/process/{processId} HTTP/1.1
Host: api.cadastro.uat.unico.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "flow": "idunicosign",
    "callbackUri": "/path/to/callback-url/",
    "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
    "state": "PROCESS_STATE_FINISHED",
    "result": "PROCESS_RESULT_OK",
    "createdAt": "2023-10-05T18:28:58.537985Z",
    "finishedAt": "2023-10-09T15:15:25.417105Z",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "73689290074",
      "friendlyName": "Luke Skywalker",
      "notifications": [
        {
          "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
        }
      ]
    },
    "purpose": "creditprocess",
    "authenticationInfo": {
      "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
      "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
      "livenessResult": "LIVENESS_RESULT_LIVE",
      "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
      "trustResult": "TRUST_RESULT_UNSPECIFIED",
      "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED",
      "faceWithOtherIdResult": "TRUST_RESULT_UNSPECIFIED",
      "frictionlessResult": "FRICTIONLESS_RESULT_UNSPECIFIED",
      "riskLevelResult": "TRUST_RESULT_UNSPECIFIED",
      "smartRevalidationResult": "SMART_REVALIDATION_RESULT_UNSPECIFIED",
      "scoreEngineResult": {
        "scoreEnabled": "SCORE_ENABLED_TRUE",
        "score": 50
      },
      "serproResult": {
        "score": 50
      }
    },
    "capacities": [
      "PROCESS_CAPACITY_IDUNICO",
      "PROCESS_CAPACITY_IDSIGN",
      "PROCESS_CAPACITY_IDLIVE"
    ],
    "services": [
      {
        "documents": [
          {
            "doc": {
              "version": 2,
              "code": "RG",
              "data": {
                "dataExpiracao": "2025-10-35T00:00:00Z",
                "dataHabilitacao": "2022-08-09T00:00:00Z",
                "dataNascimento": "1950-06-30T00:00:00Z",
                "nomeCivil": "John Doe",
                "rgNumero": 5478854,
                "categoria": "D",
                "cpfNumero": 73689290074,
                "dataEmissao": "2020-08-09T00:00:00Z",
                "localEmissao": "DEREX SP",
                "numero": 85775532778,
                "renachNumero": ""
              }
            },
            "typified": true,
            "cpf_match": true,
            "face_match": true,
            "doc_id": "1e61a978-3673-4fdd-8fa8-808d0a26d131",
            "validate_doc": true,
            "reused_doc": true,
            "signed_url": "https://api.datafortre[...]OXc9PQ%3D%3D"
          }
        ],
        "consent_granted": true,
        "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
        "documentIds": [
          "03307601-b518-49ca-b368-ae3919e24e54"
        ]
      }
    ],
    "expiresAt": "2023-10-09T15:15:25.417105Z",
    "token": "",
    "companyData": {
      "branchId": "5a62ee0b-2b78-493d-9ab7-72126798f00e",
      "countryCode": "BRA"
    },
    "bioTokenData": {
      "referenceProcessId": "92369ed7-5c3d-4050-a426-94ce8721e079",
      "authenticationId": "57f5d650-f6a6-4e07-8f1f-46f6d61089fd"
    },
    "clientReference": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
    "useCase": "USE_CASE_IDENTITY_REVALIDATION_7_DAYS"
  }
}

The content returned in the process.services.documents.doc.data parameter, referring to the OCR Extraction technology, can be consulted below:

CNH

• Type: CNH

• Content: Brazilian National Driving License

  • String numero;

  • String rgNumero;

  • String cpfNumero;

  • String nomeCivil;

  • List string filiacao;

  • Datetime dataNascimento;

  • Datetime data_habilitacao;

  • Datetime data_expiracao;

  • Datetime data_emissao;

  • String local_emissao;

  • String categoria;

  • String renachNumero;

"content": {
    "numero": "044589731564",
    "rgNumero": "123456789 SESP PR",
    "nomeCivil": "Homer Simpson",
    "filiacao": [
        "Monasimpson",
        "Monasimpson"
    ],
    "dataNascimento": "1990-05-12T00:00:00Z",
    "dataHabilitacao": "1997-11-18T00:00:00Z",
    "dataExpiracao": "2017-12-07T00:00:00Z",
    "dataEmissao": "2012-12-07T00:00:00Z",
    "localEmissao": "Curitiba PR",
    "categoria": "B",
    "renachNumero": "PR904987581"
}

RG

CIN

Passport

UNKNOWN

• If the response from the result parameter is "PROCESS_RESULT_INVALID_IDENTITY" we will not request the steps following the capture of the selfie (documents and/or electronic signature).

• If we are unable to extract a field from the document, it is not listed in the API return.

• The link returned in signed_url is valid for 5 minutes. A GET request must be made during the process to refresh the link and extend its validity.

• The document returned in the signed_url will always be a single PDF with the documents separated into front and back.

Tips:

• To implement your business rules, always validate the response from the capabilities by checking the parameters in the following order:

  • state = PROCESS_STATE_FINISHED AND result = PROCESS_RESULT_OK:

    • THEN, you can proceed with decision-making by analyzing the authenticationInfo parameter.

    • If you receive state = PROCESS_STATE_FINISHED AND result = PROCESS_RESULT_ERROR, interpret this as an error in the biometric process and attempt the process again.

• To improve the performance of your operation, you can use our Webhooks and only query the results of processes that are in the finalized statuses.

Errors

400 Bad Request

code	message	description
3	process id is invalid	When the process ID is invalid.

401 Unauthorized

404 Not Found

429 Too Many Requests

500 Internal Server Error