Documents

Los endpoints de Documents te permiten crear, consultar y gestionar documentos en AllSign. Un documento representa un archivo PDF (o DOCX que se convierte automáticamente) listo para firma electrónica.

Para entender la estructura completa del objeto Document, consulta la referencia del objeto Document.

POST/v2/documents

Create document

Crea un documento nuevo en AllSign. Este endpoint ejecuta el flujo completo de créditos empresariales: reserva del crédito document_signature, proceso del archivo y liquidación/seguimiento del uso.

Request body

Name
name
Type
string
Description
Nombre del documento (1-255 caracteres).
Name
document
Type
object
Description
Objeto que contiene el archivo en Base64 y su nombre original. Ver objeto Document.
Name
participants
Type
array
Description
Lista de firmantes. Ver objeto Participant.
Name
signatureValidation
Type
object
Description
Configuración de validaciones de firma. Ver objeto Document.
Name
config
Type
object
Description
Controla el flujo de invitaciones. Ver objeto Document.
Name
permissions
Type
object
Description
Define el propietario y colaboradores. Ver objeto Document.

Response

Devuelve el objeto Document creado con su ID único.

Request

POST

/v2/documents

PDF_BASE64=$(base64 -i ./contrato.pdf)

curl -X POST "https://api.allsign.io/v2/documents" \
  -H "Authorization: Bearer ALLSIGN_LIVE_SK" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Contrato de Servicios 2025",
    "document": {
      "name": "contrato.pdf",
      "base64Content": "'$PDF_BASE64'"
    },
    "participants": [
      {
        "email": "ceo@empresa.com",
        "name": "CEO Empresa"
      }
    ],
    "signatureValidation": {
      "autografa": true,
      "FEA": false,
      "eIDAS": false,
      "nom151": false
    },
    "config": {
      "sendInvitations": false,
      "sendByWhatsapp": false,
      "sendByEmail": false,
      "startAtStep": 1
    },
    "permissions": {
      "ownerEmail": "ceo@empresa.com"
    }
  }'

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Contrato de Servicios 2025",
  "creditsConsumed": 1,
  "createdAt": "2024-11-23T20:00:00Z"
}

GET/v2/documents/{id}

Retrieve document

Consulta los detalles de un documento existente.

Path parameters

Name
id
Type
string
Description
ID único del documento (UUID).

Response

Devuelve el objeto Document completo.

GET/v2/documents

List documents

Lista todos los documentos de la cuenta. Soporta paginación y filtros.

Query parameters

Name
limit
Type
integer
Description
Número máximo de documentos a devolver (1-100, default: 20).
Name
offset
Type
integer
Description
Número de documentos a saltar para paginación (default: 0).
Name
status
Type
string
Description
Filtra por estado: draft, active, completed, cancelled.

Response

Devuelve un array de objetos Document con metadata de paginación.

Response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Contrato de Servicios 2025",
      "createdAt": "2024-11-23T20:00:00Z"
    }
  ],
  "total": 42,
  "limit": 20,
  "offset": 0
}