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.

Endpoints:

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

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

---

Consulta do Resultado do Processo

---

Consultar Resultado do Processo

Endpoint para buscar o resultado de um processo 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

Informações do processo by Unico.

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",
    "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",
      "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
      "livenessResult": "LIVENESS_RESULT_LIVE",
      "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
      "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED",
      "scoreEngineResult": {
        "scoreEnabled": "SCORE_ENABLED_TRUE",
        "score": 50
      },
      "serproResult": {
        "score": 50
      }
    },
    "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.datafortre[...]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",
    "companyData": {
      "branchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
      "countryCode": "BRA"
    }
  }
}

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:

CNH

• Type: CNH

• Content: Carteira Nacional de Habilitação

  • 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

• Type: RG

• Content: Registro Geral

  • String numero;

  • String orgao_emissor;

  • String uf_emissor;

  • String cpfNumero;

  • String carteira_profissionalNumero;

  • String certificado_militarNumero;

  • String cnsNumero;

  • String nis_pis_pasepNumero;

  • String ctpsNumero;

  • String ctps_serie;

  • String ctps_uf;

  • String titulo_eleitorNumero;

  • String nomeCivil;

  • String nome_social;

  • List string filiacao;

  • Datetime dataNascimento;

  • String naturalidade;

  • Datetime data_emissao;

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

CIN

• Type: CIN

• Content: Carteira de Identidade Nacional

  • string rgNumero;

  • string cpfNumero;

  • string nomeCivil;

  • string nome_social;

  • List string filiacao;

  • Datetime dataNascimento;

  • Datetime data_expiracao;

  • Datetime data_emissao;

  • string orgao_emissor;

  • string local_emissao;

  • string naturalidade;

  • string nacionalidade;

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

Passaporte (BR)

• Type: PASSAPORTE

• Content: Passaporte brasileiro

  • string numero;

  • string nome;

  • string sobrenome;

  • string pais_emissor;

  • string nacionalidade;

  • string naturalidade;

  • Datetime data_nascimento;

  • Datetime data_emissao;

  • Datetime data_expiracao;

  • string autoridade.

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

UNKNOWN

• 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 com os resultados result = PROCESS_RESULT_INVALID_IDENTITY ou PROCESS_RESULT_ERROR, interprete que houve algum erro na 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 cenários que pode receber no response, consulte a seção Cenários de response;

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