API REST

Propietarios y administradores gestionan la API en Ajustes → API (/settings/api). Los miembros no pueden abrir esta página. Tu clave solo actúa sobre tu organización: listar y crear documentos, reenviar un documento y configurar tu webhook saliente. No hay otras rutas de API para el cliente. Ruta base: https://app.signyd.com/api/v1

En la aplicación

En Ajustes → API puedes:

Crear una clave live con nombre (sk_live_…).
Copiarla una vez: Copia esto ahora — . Signyd no vuelve a mostrar el secreto.
Eliminar una clave. Las peticiones que la usen dejan de funcionar.
Definir la URL del webhook y rotar el secreto.

Ver Webhooks para eventos y firma.

Autenticación

Envía este encabezado en cada petición:

Authorization: Bearer sk_live_…

Una clave ausente, revocada o eliminada responde 401 { "error": "unauthorized" }.

`GET /api/v1/documents`

Lista hasta 50 documentos de tu workspace.

{
  "data": [
    {
      "id": "uuid",
      "title": "string",
      "status": "draft|sent|partially_signed|completed|voided|expired",
      "sha256_hash": "hex|null",
      "created_at": "ISO-8601"
    }
  ]
}

`GET /api/v1/documents/:id`

Devuelve ese documento y recipients si es de tu organización. Si no, 404 { "error": "not_found" }.

`POST /api/v1/documents`

Crea un PDF, añade destinatarios y envía invitaciones de firma.

{
  "title": "Contrato de servicio",
  "filename": "acuerdo.pdf",
  "pdf_base64": "<PDF en base64>",
  "recipients": [
    {
      "email": "ada@example.com",
      "name": "Ada Lovelace",
      "kyc_required": false,
      "page_number": 1,
      "signature_x": 72,
      "signature_y": 72
    }
  ]
}

Reglas:

title, pdf_base64 y al menos un destinatario
El número de destinatarios debe respetar el máximo del plan (Starter 10, Pro/Business 40, Scale 99)
PDF máximo 15 MiB
PDF con contraseña de apertura: pdf_open_encryption
Posición de firma por defecto 72,72 en página 1
Éxito: 201 con documento y destinatarios
Crear y enviar una solicitud multiparte consume un sobre mensual cuando el proceso de firma se completa (no_credits si no quedan)

Estado	`error`
401	`unauthorized`
400	`invalid_json`, validación, `too_many_recipients`, `invalid_pdf`, `pdf_open_encryption`
413	`payload_too_large`
402	`no_credits`, `no_kyc_credits` (puede incluir `document_id`)

`POST /api/v1/documents/:id/send`

Reenvía invitaciones de un documento de tu organización. 200 { "ok": true }.

Endpoints de webhook

GET y PATCH /api/v1/webhooks están en Webhooks.

Primeros pasos

Workspace

Documentos

Biblioteca

Firma y verificación

Ajustes

Desarrolladores

En la aplicación

Autenticación

`GET /api/v1/documents`

`GET /api/v1/documents/:id`

`POST /api/v1/documents`

`POST /api/v1/documents/:id/send`

Endpoints de webhook

​En la aplicación

​Autenticación

​GET /api/v1/documents

​GET /api/v1/documents/:id

​POST /api/v1/documents

​POST /api/v1/documents/:id/send

​Endpoints de webhook

En la aplicación

Autenticación

`GET /api/v1/documents`

`GET /api/v1/documents/:id`

`POST /api/v1/documents`

`POST /api/v1/documents/:id/send`

Endpoints de webhook