Documents

{
  "success": false,
  "error_code": "EMAIL_VALIDATION_FAILED",
  "message": "One or more participant emails cannot receive messages. Check the 'participants' field and correct the following: firmante@invaliddomain.xyz: domain cannot receive email (no MX records)",
  "details": [
    {
      "email": "firmante@invaliddomain.xyz",
      "reason": "domain cannot receive email (no MX records)",
      "suggestion": null
    }
  ]
}

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "contrato.pdf",
  "pdfHash": "a1b2c3d4e5f6...",
  "description": null,
  "createdAt": "2024-11-23T20:00:00Z",
  "creditsConsumed": 1
}

{
  "status": "processing",
  "workflowId": "doc-create-550e8400-e29b-41d4-a716-446655440000",
  "progressUrl": "/v2/documents/workflows/doc-create-550e8400-e29b-41d4-a716-446655440000/progress"
}

{
  "workflowId": "doc-create-550e8400-e29b-41d4-a716-446655440000"
}

{
  "step": "processing",
  "progress": 25,
  "message": "Procesando documento..."
}

{
  "step": "complete",
  "progress": 100,
  "message": "¡Documento listo!",
  "documentId": "550e8400-e29b-41d4-a716-446655440000",
  "creditsConsumed": 1
}

{
  "code": "PROCESSING_FAILED",
  "message": "Error al procesar el documento"
}

import requests
import sseclient

API_KEY = "allsign_live_sk_TU_API_KEY"
BASE_URL = "https://api.allsign.io"
HEADERS = {"Authorization": f"Bearer {API_KEY}", "Content-Type": "application/json"}

# 1. Crear documento en modo async
response = requests.post(
    f"{BASE_URL}/v2/documents/?mode=async",
    headers=HEADERS,
    json={
        "document": {
            "base64Content": "JVBERi0xLjQK...",
            "name": "contrato.pdf"
        },
        "participants": [
            {"email": "firmante@ejemplo.com", "name": "Juan"}
        ]
    }
)

data = response.json()
print(f"Workflow iniciado: {data['workflowId']}")
# → Workflow iniciado: doc-create-550e8400-e29b-41d4-a716-446655440000

# 2. Escuchar progreso via SSE
sse_url = f"{BASE_URL}{data['progressUrl']}"
sse_response = requests.get(sse_url, headers=HEADERS, stream=True)
client = sseclient.SSEClient(sse_response)

for event in client.events():
    if event.event == "progress":
        info = json.loads(event.data)
        print(f"  [{info['progress']}%] {info['message']}")
    elif event.event == "complete":
        result = json.loads(event.data)
        print(f"✅ Documento listo: {result['documentId']}")
        break
    elif event.event == "error":
        error = json.loads(event.data)
        print(f"❌ Error: {error['message']}")
        break

// 1. Crear documento en modo async
const response = await fetch('https://api.allsign.io/v2/documents/?mode=async', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer allsign_live_sk_TU_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    document: {
      base64Content: 'JVBERi0xLjQK...',
      name: 'contrato.pdf',
    },
    participants: [
      { email: 'firmante@ejemplo.com', name: 'Juan' },
    ],
  }),
});

const { workflowId, progressUrl } = await response.json();
console.log('Workflow iniciado:', workflowId);

// 2. Escuchar progreso via SSE con fetch (soporta Authorization header)
// ⚠️ EventSource nativo NO soporta custom headers — usamos fetch + ReadableStream
const sseResponse = await fetch(`https://api.allsign.io${progressUrl}`, {
  headers: { 'Authorization': 'Bearer allsign_live_sk_TU_API_KEY' },
});

const reader = sseResponse.body.getReader();
const decoder = new TextDecoder();
let buffer = '';

while (true) {
  const { done, value } = await reader.read();
  if (done) break;

  buffer += decoder.decode(value, { stream: true });
  const lines = buffer.split('\n');
  buffer = lines.pop(); // conservar línea incompleta

  let eventType = '';
  for (const line of lines) {
    if (line.startsWith('event: ')) eventType = line.slice(7);
    if (line.startsWith('data: ')) {
      const data = JSON.parse(line.slice(6));

      if (eventType === 'progress') {
        console.log(`[${data.progress}%] ${data.message}`);
        // Actualizar UI con el progreso...
      } else if (eventType === 'complete') {
        console.log('✅ Documento listo:', data.documentId);
        reader.cancel();
        window.location.href = `/documentos/${data.documentId}`;
        return;
      } else if (eventType === 'error') {
        console.error('❌ Error:', data.message);
        reader.cancel();
        return;
      }
    }
  }
}

{
  "status": "processing",
  "step": "saving",
  "progress": 50,
  "message": "Guardando documento..."
}

{
  "status": "completed",
  "step": "complete",
  "progress": 100,
  "message": "¡Documento listo!",
  "documentId": "550e8400-e29b-41d4-a716-446655440000",
  "creditsConsumed": 1
}

{
  "status": "failed",
  "step": "error",
  "error": "Créditos insuficientes"
}

// 1. Crear documento en modo async
const createRes = await fetch('https://api.allsign.io/v2/documents/?mode=async', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer allsign_live_sk_TU_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    document: { base64Content: 'JVBERi0xLjQK...', name: 'contrato.pdf' },
    participants: [{ email: 'firmante@ejemplo.com', name: 'Juan' }],
  }),
});

const { workflowId } = await createRes.json();

// 2. Polling cada 2 segundos
let result;
while (true) {
  const res = await fetch(
    `https://api.allsign.io/v2/documents/workflows/${workflowId}/status`,
    { headers: { 'Authorization': 'Bearer allsign_live_sk_TU_API_KEY' } }
  );
  const status = await res.json();

  console.log(`[${status.progress}%] ${status.message}`);

  if (status.status === 'completed') {
    result = status;
    break;
  }
  if (status.status === 'failed') {
    throw new Error(status.error);
  }
  await new Promise(r => setTimeout(r, 2000));
}

console.log('✅ Document ready:', result.documentId);

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Contract 2024.pdf",
  "documentType": "EDITABLE",
  "createdAt": "2024-11-23T10:00:00Z",
  "updatedAt": "2024-11-23T10:00:00Z",
  "ownerId": "550e8400-e29b-41d4-a716-446655440001",
  "orgId": "550e8400-e29b-41d4-a716-446655440002",
  "categoryId": 1,
  "activePublicUrl": false,
  "signersData": {
    "id": "cdc27f13-4d05-47d0-9690-fb69d005e7f8",
    "status": "TODOS_FIRMARON",
    "signatures": [
      {
        "id": "63db6fa9-2709-4f68-9ea7-bc640194bade",
        "status": "SIGNED",
        "signer": {
          "id": "99dc8f00-be5f-4331-ae66-db71bc2f6ccb",
          "email": "firmante@empresa.com"
        }
      }
    ]
  },
  "folders": [
    {
      "id": "111e8400-e29b-41d4-a716-446655440000",
      "name": "Contratos",
      "parentId": null
    }
  ]
}

{
  "success": true,
  "message": "Documents retrieved successfully",
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Contrato de Servicios 2025.pdf",
      "documentType": "EDITABLE",
      "createdAt": "2024-11-23T20:00:00Z",
      "updatedAt": "2024-11-23T20:00:00Z",
      "ownerId": "550e8400-e29b-41d4-a716-446655440001",
      "orgId": "550e8400-e29b-41d4-a716-446655440002",
      "categoryId": 1,
      "activePublicUrl": false,
      "signersData": {
        "id": "cdc27f13-4d05-47d0-9690-fb69d005e7f8",
        "status": "ESPERANDO_FIRMAS",
        "signatures": [
          {
            "id": "63db6fa9-2709-4f68-9ea7-bc640194bade",
            "status": "SENT",
            "signer": {
              "id": "99dc8f00-be5f-4331-ae66-db71bc2f6ccb",
              "email": "firmante@empresa.com"
            }
          }
        ]
      }
    }
  ],
  "meta": {
    "limit": 10,
    "total": null,
    "hasNext": true,
    "nextCursor": "eyJzb3J0X2ZpZWxkIjoi...",
    "prevCursor": null
  }
}

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Contrato Final v2.pdf",
  "documentType": "EDITABLE",
  "createdAt": "2024-11-23T10:00:00Z",
  "updatedAt": "2024-11-24T15:30:00Z",
  "ownerId": "550e8400-e29b-41d4-a716-446655440001",
  "orgId": "550e8400-e29b-41d4-a716-446655440002",
  "categoryId": 1,
  "activePublicUrl": false,
  "signersData": null
}

{
  "detail": "Status transition 'SELLOS_PDF' → 'RECOLECTANDO_FIRMANTES' is not allowed via PATCH. Allowed transitions from 'SELLOS_PDF': none."
}

{
  "success": true,
  "newExpiresAt": "2025-06-30T23:59:59+00:00",
  "extendedCount": 1,
  "previousStatus": "EXPIRADO",
  "newStatus": "ESPERANDO_FIRMAS"
}

{
  "totalDocuments": 150,
  "totalCompleted": 42,
  "totalPending": 93,
  "totalConfiguring": 15,
  "recentCount": 12
}

{
  "success": true,
  "message": "Document deleted successfully",
  "documentId": "550e8400-e29b-41d4-a716-446655440000",
  "s3KeysCleaned": 3
}

{
  "error": {
    "code": "E1300",
    "type": "not_found",
    "message": "Document not found"
  }
}

{
  "error": {
    "code": "E1600",
    "type": "conflict",
    "message": "Document is fully signed and legally binding. Signed documents cannot be deleted."
  }
}

{
  "error": {
    "code": "E1600",
    "type": "conflict",
    "message": "Document has signatures in progress. Void the document before deleting."
  }
}

{
  "success": true,
  "message": "3 document(s) deleted successfully",
  "deletedCount": 3,
  "failedCount": 0,
  "details": [
    { "documentId": "550e8400-e29b-41d4-a716-446655440000", "success": true },
    { "documentId": "660f9511-f3ac-52e5-b827-557766551111", "success": true },
    { "documentId": "770a0622-a4bd-63f6-c938-668877662222", "success": true }
  ]
}

{
  "success": true,
  "message": "1 document(s) deleted successfully",
  "deletedCount": 1,
  "failedCount": 2,
  "details": [
    { "documentId": "550e8400-e29b-41d4-a716-446655440000", "success": true },
    { "documentId": "660f9511-f3ac-52e5-b827-557766551111", "success": false, "error": "Document is fully signed and legally binding. Signed documents cannot be deleted." },
    { "documentId": "invalid-or-unauthorized-id", "success": false, "error": "Document not found" }
  ]
}

{
  "error": {
    "code": "E1200",
    "type": "validation_error",
    "message": "List should have at least 1 item after validation, not 0",
    "field": "documentIds"
  }
}

{
  "error": {
    "code": "E1100",
    "type": "permission_error",
    "message": "Insufficient permissions. Required: document:delete or document:*."
  }
}