Inicio rápido

Envía tu primer documento para firma electrónica en 5 minutos. Desde configurar tu API key hasta tener un documento listo para firmar — paso a paso.

Paso 1: Obtén tu API key

Inicia sesión en el Dashboard de AllSign
Activa tu suscripción en Suscripción y agrega el complemento API REST
Ve a API Keys y genera tu primera clave

Tu API key se muestra una sola vez. Guárdala en un lugar seguro. El formato es allsign_live_sk_xxx para producción y allsign_test_sk_xxx para desarrollo.

Paso 2: Verifica tu conexión

Confirma que tu API key funciona con una petición de prueba:

GET

/v2/test/security

curl "https://api.allsign.io/v2/test/security" \
  -H "Authorization: Bearer allsign_live_sk_TU_API_KEY_AQUI"

Si todo está bien, recibirás:

{
  "success": true,
  "message": "API V2 security validated successfully",
  "authenticatedUser": "tu@email.com",
  "tenantId": "550e8400-e29b-41d4-a716-446655440000",
  "scopes": ["document:read", "document:write"],
  "environment": "live"
}

¿Recibes 401 Unauthorized? Verifica que el header sea exactamente Authorization: Bearer allsign_live_sk_xxx con el prefijo Bearer.

Paso 3: Crea tu primer documento

Convierte tu PDF a base64 y envíalo como JSON:

POST

/v2/documents

curl -X POST "https://api.allsign.io/v2/documents/" \
  -H "Authorization: Bearer allsign_live_sk_TU_API_KEY_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "documents": [
      {
        "base64Content": "'$(base64 < /ruta/a/tu/contrato.pdf | tr -d '\n')'",
        "fileType": "pdf",
        "name": "Mi primer contrato"
      }
    ],
    "participants": []
  }'

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Mi primer contrato",
  "createdAt": "2024-01-15T10:30:00Z",
  "pdfs": [
    { "id": "…", "position": 1, "kind": "main", "name": "Mi primer contrato", "fileType": "pdf" }
  ],
  "roles": [],
  "variables": [],
  "latencyMs": 842
}

El arreglo documents concatena de 1 a 20 PDFs en un solo documento con una firma. El campo fileType ("pdf" o "docx") es obligatorio cuando envías base64Content; los DOCX se convierten automáticamente a PDF.

Este ejemplo sube el archivo y nada más. Para concatenar varios PDFs usa documents[]. Para firmar en la misma llamada agrega participants, fields[] y config: { "sendInvitations": true, "startAtStep": 3 } — ver Modo compound. Los campos document y templateId de nivel raíz están marcados como deprecados, pero siguen siendo válidos para un solo archivo y no se retirarán con una fecha fija.

Crear el documento con este payload no consume créditos: el cobro ocurre al iniciar la firma (al enviar las invitaciones). Si agregas config: { "startAtStep": 3, "sendInvitations": true }, el create sí cobra y creditsConsumed refleja ese cobro.

🎉 ¡Listo! Tu documento está creado y listo para agregar firmantes.

¿Qué sigue?

Ya tienes AllSign funcionando. Ahora elige tu siguiente paso:

🧑‍💻 Integración por API

El flujo completo de firma tiene 4 pasos:

Crear documento → Ya lo hiciste ✅
Agregar firmantes → Define quién firma
Configurar campos de firma → Dónde va cada firma
Enviar invitaciones → Notifica a los firmantes

Ver flujo completo de contratos

📚 Recursos útiles

Autenticación — API keys, scopes y seguridad avanzada
Webhooks — Recibe notificaciones cuando un documento se firme
Errores — Códigos de error y cómo solucionarlos
OpenAPI / Postman — Importa todos los endpoints en tu cliente REST favorito