Consultar Resultado do Processo

URL Base:

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

• Produção: https://api.cadastro.unico.app.

Consultar Resultado do Processo

get

Endpoint para buscar o resultado de um processo no by Unico.

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

processIdstringObrigatório

ID do processo.

Respostas

200

Detalhes do processo obtidos com sucesso.

application/json

400

Payload inválido.

application/json

401

Erro no access-token.

application/json

404

Processo não encontrado.

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

O conteúdo retornado no parâmetro process.services.documents.doc.data, referente à tecnologia de OCR Extração, pode ser consultado abaixo:

CNH

• Type: CNH

• Content: Carteira Nacional de Habilitação

  • string numero;

  • string rgNumero;

  • string cpfNumero;

  • string nomeCivil;

  • array <string> filiacao;

  • datetime dataNascimento;

  • datetime dataHabilitacao;

  • datetime dataExpiracao;

  • string localEmissao;

  • string categoria;

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

RG

CIN

Passaporte (BR)

UNKNOWN

• Caso a resposta do parâmetro result seja "PROCESS_RESULT_INVALID_IDENTITY" não solicitaremos as etapas seguintes à captura da selfie (documentos e/ou assinatura eletrônica).

• Caso não consigamos extrair algum campo do documento, ele não é listado no retorno da API.

• O link retornado em signed_url é válido por 5 minutos, sendo necessário realizar uma requisição GET no processo para atualizá-lo e renovar sua validade.

• O documento retornado em signed_url será sempre um PDF único com os documentos separados em frente e verso.

Dicas:

• Para implementar suas regras de negócio, sempre valide o retorno das capacidades analisando os parâmetros do response na seguinte ordem:

  • state = PROCESS_STATE_FINISHED E result = PROCESS_RESULT_OK.

    • ENTÃO, pode realizar a tomada de decisão analisando os retornos do parâmetro authenticationInfo.

    • Caso receba o state = PROCESS_STATE_FINISHED E result = PROCESS_RESULT_ERROR, interprete que houve algum erro no processamento da biometria e tente novamente.

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

Erros

400 Bad Request

code	message	Descrição
3	process id is invalid	Quando o id de processo é inválido.

401 Unauthorized

404 Not Found

429 Too Many Requests

500 Internal Server Error