Consulta de pacote

GET/documentchave públicapuk_

Este serviço permite consultar pacotes de documentos no Auco.

---

Autenticação

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

Authorization: puk_xxx...

---

Parâmetros de consulta

Nome	Tipo	Descrição
package	String opcional	ID do pacote de documentos. Obrigatório se code não for informado.

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

info

Este mesmo endpoint também pode ser usado para obter informações de um documento específico. Saiba mais em consultar processos e modelos

---

🧪 Exemplos de uso

dica

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

🔹 Obter informações gerais do processo

curl

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

Python

import requests

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

Node.js

const axios = require('axios');

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

---

📥 Exemplo de resposta

{
  "_id": "ID_PACKAGE",
  "codes": ["CODEDOC1", "CODEDOC2"],
  "name": "Prueba paquete de documentos",
  "signers": [
    {
      "userId": "AI",
      "email": "example1@auco.ai",
      "name": "Firmante 1",
      "phone": "+573000000000",
      "status": "NOTIFICATION"
    },
    {
      "userId": "OR",
      "email": "example2@auco.ai",
      "name": "Firmante 2",
      "phone": "+573000000000",
      "status": "NOTIFICATION"
    }
  ],
  "signFinish": false,
  "createdAt": "2024-10-18T20:20:34.970Z",
  "updatedAt": "2024-11-15T02:02:12.775Z",
  "status": "CREATED",
  "custom": {
    "externalId": "ORDER-123",
    "source": "crm"
  }
}

info

O campo custom só aparece se foi enviado na criação do pacote (veja POST /document/many). Ele contém exatamente os dados enviados pelo integrador, sem nenhuma transformação por parte do 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 atribuída na criação.
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 aprovação do processo.
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.

---

⚠️ Respostas de erro

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