🟡 Consulta procesos y plantillas
GET /document
Este servicio permite consultar sus procesos de firma, plantillas automatizadas o tus plantillas automatizadas en Auco.
Autenticación
Incluye tu llave publica en el encabezado Authorization
.
Authorization: puk_xxx...
Parámetros de consulta
Nombre | Tipo | Requerido | Descripción |
---|---|---|---|
code | String | Opcional | Código de documento asociado al proceso. Obligatorio si no se incluye package . |
⚠️ Si no envías el atributo
code
, recibirás la lista de plantillas automatizadas.
info
Este mismo endpoint servirá para obtener paquete de documentos, ver mas en consultar paquetes de documentos
🧪 Ejemplos de uso
tip
Puedes copiar cualquiera de los ejemplos según el lenguaje de tu preferencia.
🔹 Obtener información general del proceso
- curl
- Python
- Node.js
curl --location 'https://api.auco.ai/v1.5/ext/document?code=CODEDOCUM' \
--header 'Authorization: puk_tuClavePublica'
import requests
response = requests.get(
"https://api.auco.ai/v1.5/ext/document",
headers={"Authorization": "puk_tuClavePublica"},
params={"code": "CODEDOCUM"}
)
print(response.json())
const axios = require('axios');
axios
.get('https://api.auco.ai/v1.5/ext/document', {
headers: { Authorization: 'puk_tuClavePublica' },
params: { code: 'CODEDOCUM' },
})
.then((response) => console.log(response.data));
📥 Ejemplo de respuesta
{
"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": "maurilo934@hotmail.com",
"id": "G8",
"status": "NOTIFICATION"
}
]
}
🔄 Estado del document (status
)
Estado | Descripción |
---|---|
CREATED | Cuando el procesp ha sido creado. |
REJECTED | Proceso rechazado. |
EXPIRED | Proceso expirado, solo si al momento de crearlo se asigna fecha de expiración. |
FINISH | Proceso firma o aprobado por todas las partes. |
🔄 Estado del participante (status
)
Estado | Descripción |
---|---|
NOTIFICATION | El participante ha sido notificado para firma. |
REJECT | El participante ha rechazado la firma o aprobación del proceso. |
FINISH | El participante ha firmado o aprobado el proceso. |
BLOCK | El participante ha excedido los intentos fallidos al momento de firmar o aprobar. |
PENDING | El participante no ha sido notificado, generalmente se debe a un proceso secuencial. |
⚠️ Respuestas de error
Código | Descripción |
---|---|
400 | proceso no encontrado (DOCUMENT_NOT_FOUND ) |
401 | Autenticación inválida o ausente |