Consultar processo e anexos

GET/attachmentschave públicapuk_

Este serviço permite consultar os anexos enviados pelos signatários dentro de um processo. A estrutura da resposta varia conforme o parâmetro userId seja incluído ou não.

---

Autenticação

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

Authorization: puk_xxx...

---

Parâmetros de consulta

Nome	Tipo	Descrição
package	String condicional	ID do pacote do processo. Obrigatório se code não for informado.
code	String condicional	Código do documento do processo. Obrigatório se package não for informado.
userId	String opcional	ID do usuário para consultar seus anexos individuais e seu status.

⚠️ Deve ser enviado exatamente um entre package ou code. Se ambos forem informados, a requisição é rejeitada com erro 400.

---

Combinações de uso válidas

Método	Caminho	Descrição
GET	/attachments?package={packageId}	Consulta geral do processo
GET	/attachments?code={code}	Consulta geral do processo
GET	/attachments?package={packageId}&userId={userId}	Consulta de anexos por signatário usando package
GET	/attachments?code={code}&userId={userId}	Consulta de anexos por signatário usando code

---

🧪 Exemplos de uso

dica

Você pode copiar qualquer um dos exemplos conforme a sua linguagem preferida.

🔹 Obter informações gerais do processo

curl

curl --location 'https://api.auco.ai/v1.5/ext/attachments?package=package123' \
  --header 'Authorization: puk_yourPublicKey'

Python

import requests

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

Node.js

const axios = require('axios');

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

---

🔸 Obter anexos de um signatário usando package e userId

curl

curl --location 'https://api.auco.ai/v1.5/ext/attachments?package=package456&userId=userX' \
  --header 'Authorization: puk_yourPublicKey'

Python

import requests

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

Node.js

const axios = require('axios');

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

---

🔸 Obter anexos de um signatário usando code e userId

curl

curl --location 'https://api.auco.ai/v1.5/ext/attachments?code=codeABC&userId=userY' \
  --header 'Authorization: puk_yourPublicKey'

Python

import requests

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

Node.js

const axios = require('axios');

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

---

📥 Exemplos de resposta

🔹 Sem userId

{
  "package": "package123",
  "name": "Signing Process 001",
  "finish": true,
  "signers": [
    {
      "userId": "01",
      "email": "user1@example.com",
      "name": "User One"
    }
  ]
}

🔸 Com userId

{
  "package": "package123",
  "name": "Signing Process 001",
  "finish": true,
  "signer": {
    "userId": "01",
    "email": "user1@example.com",
    "name": "User One",
    "files": [
      {
        "name": "ID Document",
        "url": "https://..."
      },
      {
        "name": "Proof",
        "url": "https://..."
      }
    ],
    "status": "approved"
  }
}

---

🔄 Status do signatário (status)

Status	Descrição
pending	O usuário ainda não enviou nenhum documento.
uploaded	O usuário enviou documentos, mas eles ainda não foram aprovados.
approved	Todos os documentos foram enviados e aprovados.

As URLs dos arquivos (url) só são incluídas se o status não for pending. São URLs assinadas temporárias, válidas por 5 minutos (300 segundos); depois de expiradas, chame o endpoint novamente para obter novos links.

---

🔚 Campo finish

O campo finish: true significa que o processo foi totalmente concluído e nenhuma outra ação é esperada.

---

⚠️ Respostas de erro

Código	Descrição
400	package ou code ausente, ou processo não encontrado (ATTACHMENT_NOT_FOUND)
401	Autenticação inválida ou ausente