1 de 1

Document Capture

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

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.

In creating the process, the following fields are required: subject.code, subject.name, document.Purpose, document.files.id or document.files.data, and imageBase64;
In the process response, we return the id, status, and document.id. The capability's response is always asynchronous; therefore, the GetProcess method must be implemented.

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.

Document Capture

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

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.

CreateProcess

Endpoint to create a new document process by Client.

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

Header parameters

Authorization*string

Valid access-token.

APIKEY*string

Valid APIKEY with document capture and reuse capability.

Body

subject*object

code*string

User's CPF.

Example: "12345678909"

name*string

User's name.

Example: "Luke Skywalker"

emailstring

User's email.

Example: "luke@unico.io"

phonestring

User's phone.

Example: "551972557070"

document*object

Information about the document to be captured.

purpose*string

Indicates the purpose of sharing the document. Can receive values: creditprocess, carpurchase, paybypaycheck, onboarding, or fgts.

Example: "creditprocess"

authProcessId*string

ID of the biometrics process that must have been carried out previously. The ID must be from a completed process with valid biometrics.

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

documentId*string

Identifier of the document to be reused. You will find it when using the GetReusableDocuments API. If you do not find a document to be reused, you must capture the document and send the base64 in the data.files parameter.

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

files*array of object

Base64 of the user's document if no reusable document is found in the GetReusableDocuments API. The array can contain 1 file (e.g., full CNH) or 2 files (e.g., CNH front and CNH back).

datastring

Image of the document encoded in base64.

Example: "/9j/4AAQSkZJR..."

imageBase64*string

Base64 of the user's selfie.

Example: "/9j/4AAQSkZJR..."

Response

Document process created successfully.

Body

idstring

Process ID.

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

statusinteger

Process status.

Example: 3

documentobject

idstring

ID of the document that was created.

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

Request

Response

In creating the process, the following fields are required: subject.code, subject.name, document.Purpose, document.files.id or document.files.data, and imageBase64;
In the process response, we return the id, status, and document.id. The capability's response is always asynchronous; therefore, the GetProcess method must be implemented.

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.

CreateProcess

Endpoint to create a new document process by Client.

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

Header parameters

Authorization*string

Valid access-token.

APIKEY*string

Valid APIKEY with document capture and reuse capability.

Body

subject*object

code*string

User's CPF.

Example: "12345678909"

name*string

User's name.

Example: "Luke Skywalker"

emailstring

User's email.

Example: "luke@unico.io"

phonestring

User's phone.

Example: "551972557070"

document*object

Information about the document to be captured.

purpose*string

Indicates the purpose of sharing the document. Can receive values: creditprocess, carpurchase, paybypaycheck, onboarding, or fgts.

Example: "creditprocess"

authProcessId*string

ID of the biometrics process that must have been carried out previously. The ID must be from a completed process with valid biometrics.

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

documentId*string

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

files*array of object

Base64 of the user's document if no reusable document is found in the GetReusableDocuments API. The array can contain 1 file (e.g., full CNH) or 2 files (e.g., CNH front and CNH back).

datastring

Image of the document encoded in base64.

Example: "/9j/4AAQSkZJR..."

imageBase64*string

Base64 of the user's selfie.

Example: "/9j/4AAQSkZJR..."

Response

Document process created successfully.

Body

idstring

Process ID.

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

statusinteger

Process status.

Example: 3

documentobject

idstring

ID of the document that was created.

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

Request

Response

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": "creditprocess",
        "authProcessId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
        "documentId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
        "files": [
          {}
        ]
      },
      "imageBase64": "/9j/4AAQSkZJR..."
    }),
});
const data = await response.json();