GetProcess

Nesta seção, você encontrará como obter o resultado de um processo no by Unico através da API REST

---

Antes de começar

---

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

• UAT: https://api.cadastro.uat.unico.app/client/v1/process;

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

---

GetProcess

Endpoint para buscar o resultado de um processo de verificação de identidade no by Unico.

GEThttps://api.cadastro.uat.unico.app/client/v1/process/{processId}

Authorization

bearerAuth

Path parameters

processId*string

ID do processo.

Response

200400401404500

Detalhes do processo obtidos com sucesso.

Body

application/json

processobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.cadastro.uat.unico.app/client/v1/process/{processId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401404500

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "flow": "iddocssign",
    "companyBranchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
    "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",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": 73689290074,
      "friendlyName": "Luke Skywalker",
      "notifications": [
        {
          "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
        }
      ]
    },
    "purpose": "creditprocess",
    "authenticationInfo": {
      "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
      "scoreEngineResult": {
        "scoreEnabled": "SCORE_ENABLED_TRUE",
        "score": 50
      },
      "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
      "livenessResult": "LIVENESS_RESULT_LIVE"
    },
    "capacities": [
      "PROCESS_CAPACITY_IDUNICO",
      "PROCESS_CAPACITY_IDCHECK",
      "PROCESS_CAPACITY_IDDOCS",
      "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.datafortress.dev.private.unico.run/url-signer/signature/dmF1bHQ6[...]OXc9PQ%3D%3D"
          }
        ],
        "consent_granted": true,
        "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
        "documentIds": [
          "03307601-b518-49ca-b368-ae3919e24e54"
        ]
      }
    ],
    "createdAt": "2023-10-05T18:28:58.537985Z",
    "finishedAt": "2023-10-09T15:15:25.417105Z",
    "expiresAt": "2023-10-09T15:15:25.417105Z"
  }
}

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 com os resultados result = PROCESS_RESULT_INVALID_IDENTITY ou PROCESS_RESULT_ERROR, interprete que houve algum erro na biometria e tente novamente.

Para verificar detalhadamente os parâmetros da API, consulte a seção Especificação de parâmetros.

Responses de erro

---

400 Bad Request

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

401 Unauthorized

message	Descrição
Jwt header is an invalid JSON	Quando o access-token utilizado contém caracteres errados.
Jwt is expired	Quando o access-token utilizado expirou

404 Not Found

code	message	Descrição
5	error getting process: rpc error: code = NotFound desc = process not found	Quando o id do processo não foi encontrado

500 Internal Server Error

code	message	Descrição
99999	Internal failure! Try again later	Quando há algum erro interno.

---

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.