Document Capture and Reuse

In this section, you will find the specific details on creating a process that includes Document Capture and Reuse as a capability

---

Introduction

---

In this section, you will find detailed documentation about the functionality of the endpoints related to the Document Capture and Reuse capability. The use of Reuse requires that there be a previous Identity Verification process and this must obtain a “YES” response OR the Risk Score equal or more than +50, otherwise it will be necessary to capture the user's document.

This is an asynchronous capability that requires consuming three endpoints, detailed in this documentation, for its full utilization.

The capabilities of the Unico IDCloud platform via Client are managed through API Keys—used as a parameter in the request headers—that define the access scope. As a prerequisite, it is necessary to have an API Key configured exclusively for the Document Capture and Reuse capability, ensuring dedicated and secure access to the resource.

Talk to your project manager to obtain the API Key with this configuration.

Getting started

---

Your API requests are authenticated using an access token. Any request that does not include a valid access token will return an error.

You can learn more about generating an access token here.

Endpoints:

• UAT: https://api.id.uat.unico.app/processes/v1;

• Production: https://api.id.unico.app/processes/v1.

GetReusableDocuments

---

GetReusableDocuments

Endpoint to get a user's documents for reuse in by Client.

GEThttps://api.id.uat.unico.app/documents/v1/client/v1/process

Query parameters

Header parameters

Response

200400403404500

Process information retrieved successfully.

Body

application/json

itemsarray of object

List of documents associated with the process.

Request

JavaScriptCurlPython

const response = await fetch('https://api.id.uat.unico.app/documents/v1/client/v1/process?code=text&type=text', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "APIKEY": "text"
    },
});
const data = await response.json();

Response

200400403404500

{
  "items": [
    {
      "documentType": "unico.moja.dictionary.br.rg.v2.Rg",
      "documentId": "2aaf6037-0153-415d-b9fe-cf7e8198408f"
    }
  ]
}

If you find a document to be reused, in the process creation endpoint you will enter the ID of this document in the document.documentId parameter and it will not be necessary to capture the document and send the base64 in the document.files parameter.

CreateProcess

---

Create process

Endpoint to create a new Document process via Client.

POSThttps://api.id.uat.unico.app/processes/v1/

Header parameters

Body

application/json

subject*object

User information.

document*object

Information about the document to be captured.

Response

200400500

Document process successfully created.

Body

application/json

idstring

Process ID.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

statusenum

Process status. Possible values: '1': Processing; '3' - Completed; '4' - Canceled (e.g., timeout); '5' - Error.

Example: 1

1345

documentobject

Document information.

Request

JavaScriptCurlPython

const response = await fetch('https://api.id.uat.unico.app/processes/v1/', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "APIKEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subject": {
        "code": "12345678909",
        "name": "Luke Skywalker"
      },
      "document": {
        "purpose": null,
        "authProcessId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
        "documentId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
        "files": [
          {}
        ]
      }
    }),
});
const data = await response.json();

Response

200400500

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 1,
  "document": {
    "id": "80371b2a-3ac7-432e-866d-57fe37896ac6"
  }
}

Important:

• To use the Document Capture and Reuse capability, the Identity Verification capability must be used beforehand, as it is necessary to include the processId obtained from the Identity Verification in the document.authProcessId parameter:

  • The process must have valid biometrics, be used within 24 hours of completion and cannot be reused.

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

• If an error occurs during biometric processing, the request will return a status code = 200, and the process will return a status = 5, as shown in the example below:

    {
    "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
    "status": 5
    }

GetProcess

---

GetProcess

Endpoint to get the result of a Document Capture and Reuse process via by Client.

GEThttps://api.id.uat.unico.app/processes/v1/{processId}

Path parameters

processId*string

Process ID.

Header parameters

Response

200400403404410500

Process information successfully retrieved.

Body

application/json

idstring

Process ID.

Example: "2b034568-dfaf-463f-94fb-18ed93c312e8"

statusenum

Process status. Possible values: '1' - In processing; '3' - Completed; '4' - Canceled (e.g., timeout); '5' - Error.

Example: 3

1345

documentobject

Document information.

Request

JavaScriptCurlPython

const response = await fetch('https://api.id.uat.unico.app/processes/v1/{processId}', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "APIKEY": "text"
    },
});
const data = await response.json();

Response

200400403404410500

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "document": {
    "id": "b97c3fd9-d95d-413f-bc0a-75eb87304421",
    "type": "Driver's License",
    "cpfMatch": false,
    "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"
    },
    "fileUrls": [
      "https://url-signer-1",
      "https://url-signer-2"
    ]
  }
}

Content returned in document.content based on document.type:

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

• Type: RG

• Content: Brazilian General Registration

  • 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: Brazilian national Identity Card

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

Passport

• Type: Passport

• Content: Brazilian Passport

  • 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: Unknown document.

content {
}

Attention:

• When making a GET request for a process with status = 5 (error), the return status code will be 410 (Gone) instead of 200 (Success).

• Since there are no drops in the process creation request, document processing errors will be returned in the response of the query endpoint. At this point, you should interpret the returns and, if necessary, guide your user through a retry flow.

Tips:

• When implementing your business rules, always validate the final statuses of the processes (3, 4, 5). To validate the response of IDCloud capabilities, only consider status = 3 for your decision-making process;

• For more information about possible errors for this endpoint, refer to the Errors section.

---

Still need help?​

Didn't find something or still need help? If you're already a client or partner, you can reach out through our Help Center.