Consultar Resultado do Processo

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

Introdução

Nesta seção, você encontrará a documentação detalhada sobre o funcionamento do endpoint de Consulta do Resultado de Processos no by Unico.

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.

URL Base:

UAT: https://api.cadastro.uat.unico.app;
Produção: https://api.cadastro.unico.app.

Consulta do Resultado do Processo

Consultar Resultado do Processo

get

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

Autorizações

Parâmetros de rota

processIdstringObrigatório

ID do processo.

Respostas

200

Detalhes do processo obtidos com sucesso.

application/json

400

Quando o ID de processo é inválido.

application/json

401

Erro no access-token.

application/json

404

Quando não foi possível encontrar o processo.

application/json

500

Erro inesperado (Erro interno ou problema de parâmetro).

application/json

get

GET /client/v1/process/{processId} HTTP/1.1
Host: api.cadastro.uat.unico.app
Authorization: Bearer JWT
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",
      "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED",
      "idSmartResult": "IDSMART_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"
  }
}

Os processos devem ser criados exclusivamente em uma comunicação backend-to-backend, devido à nossa política de CORS, que impede a criação de processos em uma comunicação frontend-to-backend.

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

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

Type: RG
Content: Registro Geral
- string numero;
- string cpfNumero;
- string nomeCivil;
- array <string> filiacao;
- datetime dataNascimento;
- datetime dataEmissao;
- string naturalidade;
- string orgaoEmissor;
- string ufEmissor;

"content": {
    "numero": "4815162342",
    "cpfNumero": "54858809080",
    "nomeCivil": "Daniel Coelho Da Costa",
    "filiacao": [
        "Rosa Coelho Da Costa",
        "Edivaldo Da Costa",
    ],
    "dataNascimento": "1980-12-19T03:00:00Z",
    "dataEmissao": "2012-12-21T02:00:00Z",
    "naturalidade": "Sao Paulo SP",
    "orgaoEmissor": "Secretaria Da Segurança Pública (SSP)",
    "ufEmissor": "UF_SP"
}

Type: CIN
Content: Carteira de Identidade Nacional
- string cpfNumero;
- string nomeCivil;
- array <string> filiacao;
- datetime dataNascimento;
- datetime dataEmissao;
- datetime dataExpiracao;
- string orgaoEmissor;
- string naturalidade;
- string nacionalidade;
- string localEmissao;

"content": {
    "cpfNumero": "54858809080",
    "nomeCivil": "Vitor Ra",
    "filiacao": [
        "Danilo Luis Renan Ramos",
        "Giovanna Vitoria",
    ],
    "dataNascimento": "1980-12-19T03:00:00Z",
    "dataEmissao": "2024-03-02T00:00:00Z",
    "dataExpiracao": "2034-03-02T00:00:00Z",
    "orgaoEmissor": "Detran/Rj",
    "naturalidade": "Rio De Janeiro RJ",
    "nacionalidade": "BRA",
    "localEmissao": "Rio De Janeiro RJ",

}

Type: PASSAPORTE
Content: Passaporte brasileiro
- string numero;
- string nome;
- string sobrenome;
- string paisEmissor;
- string nacionalidade;
- string naturalidade;
- array <string> filiacao;
- datetime dataNascimento;
- datetime dataEmissao;
- datetime dataExpiracao;
- string autoridade.

"content": {
    "numero": "AA011906",
    "nome": "CHANCHÃO AMARELO",
    "sobrenome": "PASSAREDO",
    "paisEmissor": "BRA",
    "nacionalidade": "BRASILEIRO(A)",
    "naturalidade": "<null>",
    "filiacao": [
         "Monasimpson",
         "Monasimpson"
    ],
    "dataNascimento": "1920-06-01T00:00:00Z",
    "dataEmissao": "2000-01-01T00:00:00Z",
    "dataExpiracao": "2010-01-01T00:00:00Z",
    "autoridade": "SR/DPF/DF"
}

Type: UNKNOWN
Content: Documento desconhecido. Significa que não foi possível detectar o tipo daquele documento.

content {
}

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

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;
Para mais informações sobre os erros possíveis para este endpoint, consulte a seção Erros.

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.

AnteriorCriação de processos separados por flows PróximoObter Selfie do Usuário

Atualizado há 14 dias

Introdução

Antes de começar

Consulta do Resultado do Processo

Consultar Resultado do Processo

Dúvidas?​

Introdução

Antes de começar

Consulta do Resultado do Processo

Consultar Resultado do Processo

Dúvidas?​

Dúvidas?

Dúvidas?