1 de 1

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.

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.

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

Authorization*string

Access-token válido.

APIKEY*string

APIKEY válida com a capacidade de captura e reaproveitamento de documentos.

Body

subject*object

code*string

CPF do usuário.

Example: "12345678909"

name*string

Nome do usuário.

Example: "Luke Skywalker"

emailstring

E-mail do usuário.

Example: "luke@unico.io"

phonestring

Telefone do usuário.

Example: "551972557070"

document*object

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

purpose*string

Indica o propósito do compartilhamento do documento. Pode receber os valores: creditprocess, carpurchase, paybypaycheck, onboarding ou fgts

authProcessId*string

ID do processo de biometria que deve ter sido realizado anteriormente. O ID deve ser de um processo concluído com uma biometria válida.

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

documentId*string

É o identificador do documento para ser reaproveitado. Você o encontrará ao utilizar a API GetReusableDocuments. Caso não encontre um documento para ser reaproveitado, deve-se capturar o documento e enviar o base64 no parâmetro data.files.

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

files*array of object

Base64 do documento do usuário caso não encontre um para ser reaproveitado na API GetReusableDocuments. O array pode conter 1 arquivo (ex: CNH inteira) ou 2 arquivos (ex: CNH frente e CNH verso)

datastring

Imagem do documento codificada em base64.

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

imageBase64*string

Base64 da selfie do usuário.

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

Response

Processo de documento criado com sucesso.

Body

idstring

ID do processo.

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

statusinteger

Status do processo.

Example: 3

documentobject

idstring

ID do documento que foi criado.

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

Request

Response

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.

CreateProcess

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

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

Header parameters

Authorization*string

Access-token válido.

APIKEY*string

APIKEY válida com a capacidade de captura e reaproveitamento de documentos.

Body

subject*object

code*string

CPF do usuário.

Example: "12345678909"

name*string

Nome do usuário.

Example: "Luke Skywalker"

emailstring

E-mail do usuário.

Example: "luke@unico.io"

phonestring

Telefone do usuário.

Example: "551972557070"

document*object

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

purpose*string

Indica o propósito do compartilhamento do documento. Pode receber os valores: creditprocess, carpurchase, paybypaycheck, onboarding ou fgts

authProcessId*string

ID do processo de biometria que deve ter sido realizado anteriormente. O ID deve ser de um processo concluído com uma biometria válida.

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

documentId*string

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

files*array of object

Base64 do documento do usuário caso não encontre um para ser reaproveitado na API GetReusableDocuments. O array pode conter 1 arquivo (ex: CNH inteira) ou 2 arquivos (ex: CNH frente e CNH verso)

datastring

Imagem do documento codificada em base64.

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

imageBase64*string

Base64 da selfie do usuário.

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

Response

Processo de documento criado com sucesso.

Body

idstring

ID do processo.

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

statusinteger

Status do processo.

Example: 3

documentobject

idstring

ID do documento que foi criado.

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

Captura de documentos

Antes de começar

Endpoints:

Dúvidas?​

Captura de documentos

Antes de começar

Endpoints:

CreateProcess

Dúvidas?​

CreateProcess

Dúvidas?

Dúvidas?