Consultar Proceso y Anexos

GET/attachmentsllave públicapuk_

Este servicio permite consultar los anexos cargados por los firmantes dentro de un proceso. El comportamiento de la respuesta varía según se incluya o no el parámetro userId.

---

Autenticación

Incluye tu llave publica en el encabezado Authorization.

Authorization: puk_xxx...

---

Parámetros de consulta

Nombre	Tipo	Descripción
package	String condicional	ID del paquete del proceso. Obligatorio si no se incluye code.
code	String condicional	Código de documento asociado al proceso. Obligatorio si no se incluye package.
userId	String opcional	ID del usuario para obtener sus anexos y estado.

⚠️ Se debe enviar uno y solo uno entre package o code. Si se envían ambos, la petición será rechazada con error 400.

---

Combinaciones válidas de uso

Método	Ruta	Descripción
GET	/attachments?package={packageId}	Consulta general del proceso
GET	/attachments?code={code}	Consulta general del proceso
GET	/attachments?package={packageId}&userId={userId}	Consulta de anexos por firmante usando package
GET	/attachments?code={code}&userId={userId}	Consulta de anexos por firmante usando código

---

🧪 Ejemplos de uso

tip

Puedes copiar cualquiera de los ejemplos según el lenguaje de tu preferencia.

🔹 Obtener información general del proceso

curl

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

Python

import requests

response = requests.get(
  "https://api.auco.ai/v1.5/ext/attachments",
  headers={"Authorization": "puk_tuClavePublica"},
  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_tuClavePublica' },
    params: { package: 'package123' },
  })
  .then((response) => console.log(response.data));

---

🔸 Obtener anexos de un firmante con package y userId

curl

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

Python

import requests

response = requests.get(
  "https://api.auco.ai/v1.5/ext/attachments",
  headers={"Authorization": "puk_tuClavePublica"},
  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_tuClavePublica' },
    params: { package: 'package456', userId: 'userX' },
  })
  .then((response) => console.log(response.data));

---

🔸 Obtener anexos de un firmante con code y userId

curl

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

Python

import requests

response = requests.get(
  "https://api.auco.ai/v1.5/ext/attachments",
  headers={"Authorization": "puk_tuClavePublica"},
  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_tuClavePublica' },
    params: { code: 'codeABC', userId: 'userY' },
  })
  .then((response) => console.log(response.data));

---

📥 Ejemplos de respuesta

🔹 Sin userId

{
  "package": "paquete123",
  "name": "Proceso de firma 001",
  "finish": true,
  "signers": [
    {
      "userId": "01",
      "email": "usuario1@dominio.com",
      "name": "Usuario Uno"
    }
  ]
}

🔸 Con userId

{
  "package": "paquete123",
  "name": "Proceso de firma 001",
  "finish": true,
  "signer": {
    "userId": "01",
    "email": "usuario1@dominio.com",
    "name": "Usuario Uno",
    "files": [
      {
        "name": "Documento Identidad",
        "url": "https://..."
      },
      {
        "name": "Comprobante",
        "url": "https://..."
      }
    ],
    "status": "approved"
  }
}

---

🔄 Estado del firmante (status)

Estado	Descripción
pending	El usuario aún no ha cargado documentos.
uploaded	El usuario ya cargó documentos, pero aún no han sido aprobados.
approved	Todos los documentos han sido cargados y aprobados.

Los enlaces (url) de los archivos se incluyen solo si el status es distinto de pending. Son URLs firmadas temporales con una validez de 5 minutos (300 segundos); una vez expiradas debes consultar de nuevo el endpoint para obtener enlaces vigentes.

---

🔚 Campo finish

El campo finish: true indica que el proceso ha sido finalizado completamente y no se esperan más acciones.

---

⚠️ Respuestas de error

Código	Descripción
400	Faltan parámetros package o code, o proceso no encontrado (ATTACHMENT_NOT_FOUND)
401	Autenticación inválida o ausente