Consultar processos e modelos

GET/documentchave públicapuk_

Este serviço permite consultar seus processos de assinatura, modelos automatizados ou seus próprios modelos automatizados na Auco.

Autenticação

Inclua sua chave pública no cabeçalho Authorization.

Authorization: puk_xxx...

Parâmetros de consulta

Nome	Tipo	Descrição
`code`	String opcional	Código do documento associado ao processo. Obrigatório se `package` não for incluído.
`image`	String opcional	Se `"true"`, inclui na resposta as imagens de identificação e foto dos signatários.

⚠️ Se você não enviar o atributo code, receberá uma lista de modelos automatizados.

info

Este mesmo endpoint também pode ser usado para obter um pacote de documentos; veja mais em consultar pacotes de documentos.

🧪 Exemplos de uso

dica

Você pode copiar qualquer um dos exemplos de acordo com a linguagem de programação de sua preferência.

🔹 Obter as informações gerais do processo

curl
Python
Node.js

curl --location 'https://api.auco.ai/v1.5/ext/document?code=CODEDOCUM' \
  --header 'Authorization: puk_yourPublicKey'

import requests

response = requests.get(
  "https://api.auco.ai/v1.5/ext/document",
  headers={"Authorization": "puk_yourPublicKey"},
  params={"code": "CODEDOCUM"}
)
print(response.json())

const axios = require('axios');

axios
  .get('https://api.auco.ai/v1.5/ext/document', {
    headers: { Authorization: 'puk_yourPublicKey' },
    params: { code: 'CODEDOCUM' },
  })
  .then((response) => console.log(response.data));

🔹 Obter o processo com as imagens dos signatários

Ao incluir o parâmetro image=true, a resposta incluirá as imagens de identificação e foto dos signatários, quando disponíveis.

curl
Python
Node.js

curl --location 'https://api.auco.ai/v1.5/ext/document?code=CODEDOCUM&image=true' \
  --header 'Authorization: puk_yourPublicKey'

import requests

response = requests.get(
  "https://api.auco.ai/v1.5/ext/document",
  headers={"Authorization": "puk_yourPublicKey"},
  params={"code": "CODEDOCUM", "image": "true"}
)
print(response.json())

const axios = require('axios');

axios
  .get('https://api.auco.ai/v1.5/ext/document', {
    headers: { Authorization: 'puk_yourPublicKey' },
    params: { code: 'CODEDOCUM', image: 'true' },
  })
  .then((response) => console.log(response.data));

📥 Exemplo de resposta

{
  "url": "https://signed_url",
  "name": "prueba firma garabato",
  "code": "CODEDOCUM",
  "status": "CREATED",
  "data": {
    "code": "CODEDOCUM",
    "name": "prueba firma garabato",
    "camera": false,
    "otpCode": false,
    "signFinish": false,
    "signProfile": [
      {
        "name": "Firmante de prueba",
        "email": "example@auco.ai",
        "id": "G8",
        "status": "NOTIFICATION"
      }
    ],
    "createdAt": "2025-01-02T16:54:00.297Z",
    "updatedAt": "2025-01-02T16:54:03.105Z"
  },
  "signProfile": [
    {
      "name": "Mauricio Lopez",
      "email": "example@auco.ai",
      "id": "G8",
      "status": "NOTIFICATION"
    }
  ],
  "custom": {
    "externalId": "ORDER-123",
    "source": "crm"
  }
}

info

O campo custom só aparece se tiver sido enviado na criação do processo (veja POST /document/upload). Ele contém exatamente os dados enviados pelo integrador, sem nenhuma transformação por parte da Auco.

🔄 Status do documento (`status`)

Status	Descrição
`CREATED`	Quando o processo foi criado.
`REJECTED`	Processo rejeitado.
`EXPIRED`	Processo expirado, somente se uma data de expiração foi definida.
`FINISH`	Processo assinado ou aprovado por todas as partes.

🔄 Status do participante (`status`)

Status	Descrição
`NOTIFICATION`	O participante foi notificado para assinar.
`REJECT`	O participante rejeitou a assinatura ou a aprovação.
`FINISH`	O participante assinou ou aprovou o processo.
`BLOCK`	O participante excedeu as tentativas falhas ao assinar ou aprovar.
`PENDING`	O participante não foi notificado, geralmente devido a um processo sequencial.

🖼️ Imagens dos signatários

Quando o parâmetro image=true é enviado, cada objeto em signProfile pode incluir os seguintes campos de imagem:

Campo	Descrição
`identificationCard`	Foto da frente do documento de identidade
`identificationCardBack`	Foto do verso do documento de identidade
`photo`	Selfie/foto do signatário

Formato das imagens

Cada campo de imagem tem a seguinte estrutura:

{
  "type": "base64 | presigned",
  "data": "..."
}

Tipo	Conteúdo de `data`	Descrição
`base64`	`data:image/jpeg;base64,...`	A imagem está codificada em base64
`presigned`	URL do S3 (por exemplo, `https://s3...`)	URL assinada válida por 5 minutos

Exemplo de resposta com imagens

{
  "url": "https://signed_url",
  "name": "Contrato de serviços",
  "code": "CODEDOCUM",
  "status": "FINISH",
  "signProfile": [
    {
      "name": "John Smith",
      "email": "john@example.com",
      "id": "G8",
      "status": "FINISH",
      "identificationCard": {
        "type": "presigned",
        "data": "https://s3.amazonaws.com/bucket/..."
      },
      "identificationCardBack": {
        "type": "presigned",
        "data": "https://s3.amazonaws.com/bucket/..."
      },
      "photo": {
        "type": "base64",
        "data": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
      }
    }
  ]
}

aviso

As URLs pré-assinadas são válidas por 5 minutos. Certifique-se de baixar as imagens antes que expirem.

⚠️ Respostas de erro

Código	Descrição
400	Processo não encontrado (`DOCUMENT_NOT_FOUND`)
401	Autenticação inválida ou ausente

Autenticação​

Parâmetros de consulta​

🧪 Exemplos de uso​

🔹 Obter as informações gerais do processo​

🔹 Obter o processo com as imagens dos signatários​

📥 Exemplo de resposta​

🔄 Status do documento (status)​

🔄 Status do participante (status)​

🖼️ Imagens dos signatários​

Formato das imagens​

Exemplo de resposta com imagens​

⚠️ Respostas de erro​