Referencia API · Sesiones

Sesiones de firma

Una sesión representa el flujo de un documento y su firmante. Creala desde tu backend y seguí su estado hasta obtener el documento final.

POST/api/v1/signing-sessionsCrear sesión

Requiere `signing-sessions:write`. Acepta `multipart/form-data`: un PDF en `file` y el objeto JSON en `data`.

bashFirmARDigital API

curl --request POST https://www.firmardigital.com/api/v1/signing-sessions \
  --header "Authorization: Bearer fmr_live_TU_CLAVE" \
  --header "Idempotency-Key: contrato-4821-v1" \
  --form "file=@acuerdo.pdf;type=application/pdf" \
  --form 'data={
    "externalId":"cliente-4821",
    "title":"Acuerdo comercial",
    "recipient": {"name":"María González","email":"maria@ejemplo.com"}
  }'

Multipart `data` part

Campo	Tipo	Obligatorio	Descripción
title	string	Sí	Título visible del documento, hasta 255 caracteres.
registeredSignerId	string	No	ID devuelto al crear el firmante. Informá este o externalId.
externalId	string	No	ID propio usado al enrolar. Informá este o registeredSignerId.
recipient.name	string	Sí	Nombre del destinatario de la sesión.
recipient.email	email	Sí	Email que recibe la solicitud de firma.
signaturePlacements	array	No	Opcional. Posiciones con pageIndex, x, y, width y height; sin ellas el firmante decide la ubicación.

201

Sesión creada

jsonFirmARDigital API

{
  "success": true,
  "data": {
    "documentId": "cme0tc1tw0003s6a1c4g2n8fj",
    "sessionUrl": "https://www.firmardigital.com/f/cme0tc1tw…",
    "expiresAt": "2026-08-01T18:00:00.000Z",
    "reused": false
  }
}

GET/api/v1/signing-sessions/:idConsultar estado

Requiere `signing-sessions:read`. Cuando el estado es `SIGNED`, la respuesta puede incluir la URL de descarga.

bashFirmARDigital API

curl https://www.firmardigital.com/api/v1/signing-sessions/DOCUMENT_ID \
  --header "Authorization: Bearer fmr_live_TU_CLAVE"

200

Documento firmado

jsonFirmARDigital API

{
  "success": true,
  "data": {
    "documentId": "cme0tc1tw0003s6a1c4g2n8fj",
    "status": "SIGNED",
    "registeredSignerId": "cme0s9s8r0001s6a1wz6w2d4f",
    "recipientEmail": "maria@ejemplo.com",
    "signedAt": "2026-08-01T16:22:41.000Z",
    "createdAt": "2026-08-01T16:00:00.000Z",
    "downloadUrl": "https://www.firmardigital.com/api/v1/signing-sessions/cme0tc1tw…/download"
  }
}

GET/api/v1/signing-sessions/:id/downloadObtener PDF firmado

Requiere `signing-sessions:read`. Devuelve una URL temporal únicamente para sesiones firmadas y cuya copia verificada ya está disponible. La URL expira a los 3600 segundos.

200

URL de descarga temporal

jsonFirmARDigital API

{
  "success": true,
  "data": {
    "url": "https://storage.example.com/signed/…",
    "sha256": "ab47…f0c2",
    "expiresInSeconds": 3600
  }
}