Query Processes and Templates

GET /document

This service allows you to query your signature processes, automated templates, or your own automated templates in Auco.

---

Authentication

Include your public key in the Authorization header.

Authorization: puk_xxx...

---

Query Parameters

Name	Type	Required	Description
code	String	Optional	Document code associated with the process. Required if package is not included.

⚠️ If you do not send the code attribute, you will receive a list of automated templates.

info

This same endpoint can also be used to retrieve a document package, see more at the link.

---

🧪 Usage Examples

tip

You can copy any of the examples according to your preferred programming language.

🔹 Get General Process Information

curl

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

Python

import requests

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

---

📥 Example Response

{
  "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"
    }
  ]
}

---

🔄 Document Status (status)

Status	Description
CREATED	When the process has been created.
REJECTED	Process rejected.
EXPIRED	Process expired, only if an expiration date was set.
FINISH	Process signed or approved by all parties.

---

🔄 Participant Status (status)

Status	Description
NOTIFICATION	The participant has been notified for signing.
REJECT	The participant has rejected the signing or approval.
FINISH	The participant has signed or approved the process.
BLOCK	The participant exceeded failed attempts while signing or approving.
PENDING	The participant has not been notified, usually due to a sequential process.

---

⚠️ Error Responses

Code	Description
400	Process not found (DOCUMENT_NOT_FOUND)
401	Invalid or missing authentication