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

Body

application/json

subject*object

document*object

Information about the document to be captured.

imageBase64*string

Base64 of the user's selfie.

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

Response

200400500

Document process created successfully.

Body

application/json

idstring

Process ID.

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

statusinteger

Process status.

Example: 3

documentobject

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

Response

200400500

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

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