Saltar al contenido principal
Integración

API REST de
Certifirm

Automatiza envíos certificados, sellos de tiempo y gestión de contactos directamente desde tu aplicación o ERP.

request.sh
curl -X POST \
  https://api-v3.certifirm.eu/envelopes \
  -H "Authorization: Bearer <tu_token>" \
  -F "documento=@/ruta/al/contrato.pdf" \
  -F 'recipients=[{"email":"cliente@empresa.com","name":"María Pérez","phone":"+34612000111","requireOtp":true}]' \
  -F "description=Contrato de servicios 2026"

Autenticación

Todos los endpoints requieren autenticación mediante token Bearer. Crea tus tokens desde el panel de control, en Mis Datos → Tokens.

URL base

https://api-v3.certifirm.eu

Header de autenticación

Authorization: Bearer <token>

Formato de datos

JSON en el cuerpo · multipart/form-data cuando se sube un fichero · query string en los listados. Los listados responden { data, total } con offset, limit y sort=campo:asc|desc.

Ejemplos

Ejemplos de uso

Una muestra de llamadas a la API — con los métodos HTTP que usa — sobre envíos y contactos. No son los endpoints más importantes ni la lista completa: la referencia de todos los endpoints está en el panel de control.

POST/envelopesCrea un nuevo envío de Entrega Certificada

Parámetros

CampoTipoReq.
documentofileSí — salvo plantilla con documento
recipientsstring (JSON)Sí
signatureTypestringNo — SIMPLE|MULTIPLE
templateIdnumberSí
descriptionstringNo
scheduledDatestringNo — envío programado
fieldsstring (JSON) No — campos rellenables (sin documento ni fields, los de la plantilla)
Formato de recipients:
Array JSON codificado como campo multipart, de hasta 250 destinatarios en un envío SIMPLE y 100 en uno MULTIPLE (si se supera: DEMASIADOS_DESTINATARIOS). De cada destinatario solo email es obligatorio; el resto activa los pasos que debe superar esa persona:
name, phone, requireOtp, requireDocument, requireLiveness, forceDocumentText.
Ejemplo:
[{"email":"ana@empresa.com","name":"Ana","phone":"+34612000111","requireOtp":true},{"email":"luis@empresa.com"}]

Ejemplo (binario)

curl -X POST https://api-v3.certifirm.eu/envelopes \
  -H "Authorization: Bearer <tu_token>" \
  -F "documento=@/ruta/al/contrato.pdf" \
  -F 'recipients=[{"email":"ana@empresa.com","phone":"+34612000111","requireOtp":true}]' \
  -F "description=Contrato de servicios 2026" \
  -F "templateId=12"

// Respuesta 201 — envíos creados
[
  { "id": 1042, "recipientEmail": "ana@empresa.com" }
]
GET/envelopesLista los envíos con paginación y filtros

Parámetros (query string)

CampoDescripción
offsetOffset (paginación), defecto 0
limitNúmero de resultados, defecto 10 (máx. 500)
idFiltrar por ID de envío
signatureTypeSIMPLE o MULTIPLE
startDateCreados desde esta fecha, aaaa-mm-dd

Ejemplo

curl "https://api-v3.certifirm.eu/envelopes?offset=0&limit=5" \
  -H "Authorization: Bearer <tu_token>"

// Respuesta 200
{
  "data": [
    {
      "id": 1042,
      "recipientEmail": "ana@empresa.com",
      "description": "Contrato de servicios 2026",
      "currentState": "EMAIL_ENVIADO",
      "finalState": null,
      "createdAt": 1745488800000
    }
  ],
  "total": 1
}
POST/envelopes/{id}/cancelCancela un envío antes de que sea firmado

Parámetros

CampoTipoReq.
id (en la ruta)numberSí

Ejemplo

curl -X POST https://api-v3.certifirm.eu/envelopes/1042/cancel \
  -H "Authorization: Bearer <tu_token>"

// Respuesta 201 — envío cancelado (extracto)
{
  "id": 1042,
  "currentState": "CANCELADO_POR_EL_USUARIO",
  "finalState": "CANCELADO"
}
PATCH/contacts/{id}Actualiza un contacto de la agenda

Parámetros (body JSON)

CampoTipoReq.
id (en la ruta)numberSí
emailstringSí
namestringNo
companystringNo
phonestringNo

Ejemplo

curl -X PATCH https://api-v3.certifirm.eu/contacts/58 \
  -H "Authorization: Bearer <tu_token>" \
  -H "Content-Type: application/json" \
  -d '{"email":"ana@empresa.com","name":"Ana García López"}'

// Respuesta 200 — contacto actualizado
{
  "id": 58,
  "email": "ana@empresa.com",
  "name": "Ana García López",
  "company": "Empresa S.L.",
  "phone": "+34612000111",
  "ownerId": 7
}
DELETE/contacts/{id}Elimina un contacto de la agenda

Parámetros (en la ruta)

CampoTipoReq.
idnumberSí

Ejemplo

curl -X DELETE "https://api-v3.certifirm.eu/contacts/58" \
  -H "Authorization: Bearer <tu_token>"

// Respuesta 204 — contacto eliminado, sin cuerpo

Referencia

Documentación de la API

La referencia completa de endpoints — parámetros, tipos de datos, respuestas de ejemplo y explorador interactivo — está disponible dentro del panel de control.

Acceso disponible tras registro

El registro es gratuito.

Documentación interactiva

Desde el panel de control tienes acceso a la referencia completa de todos los endpoints, con parámetros, tipos de datos, respuestas de ejemplo y un explorador interactivo.

Ir al panel de control

¿Necesitas ayuda?

Si tienes dudas sobre la integración o necesitas soporte técnico, nuestro equipo está disponible por email o desde la pestaña de soporte del panel.

Contactar con soporte

Empieza a integrar hoy

Crea tu cuenta, genera un token de acceso y realiza tu primera llamada a la API en minutos.