Captura de documentos

Nesta seção, você encontrará as particularidades de criar um processo que tenha a Captura de documentos como capacidade

---

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.id.uat.unico.app/processes/v1;

• Produção: https://api.id.unico.app/processes/v1.

---

CreateProcess

Endpoint para criar um novo processo de documentos no by Client.

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

Header parameters

Body

application/json

subject*object

document*object

Informações sobre o documento que será capturado.

imageBase64*string

Base64 da selfie do usuário.

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

Response

200400500

Processo de documento criado com sucesso.

Body

application/json

idstring

ID do processo.

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

statusinteger

Status do processo.

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

Note que para a utilização da capacidade de Captura de documentos:

• Na criação do processo, são obrigatórios subject.code, subject.name, document.Purpose, document.files.documentId ou document.files.data e imageBase64;

  • O valor do parâmetro document.documenId só será informado na requisição caso tenha encontrado um ID de documento na API "GetReusableDocuments".

  • Caso não tenha encontrado nenhum ID de documento na API "GetReusableDocuments", você deve enviar o base64 do documento capturado como um valor do parâmetro document.files.data

• No response do processo, devolvemos o id, status e o document.id. A resposta da capacidade é sempre assíncrona, portanto deve-se implementar o método GetProcess.

---

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.