Array JSON con los datos de los firmantes. Use este parámetro cuando solo va a enviar UN contrato. Para enviar varios contratos en una sola petición, use ENVIOS en su lugar (ver más abajo).

Cada elemento del array debe contener:
Nombre : (Obligatorio si VERIFICACIONIDENTIDAD=NO) Nombre y apellidos del firmante.
NIF : (Obligatorio si VERIFICACIONIDENTIDAD=NO) NIF/DNI del firmante.
Email : (Opcional pero requerido si no incluye Telefono) Email del firmante.
Telefono : (Opcional pero requerido si no incluye Email) Móvil del firmante con prefijo internacional sin '+', ej. '34600000001'.
Orden : (Opcional) Orden de firma cuando hay varios firmantes. El firmante con menor Orden firma primero.

Si VERIFICACIONIDENTIDAD=SI, los campos Nombre y NIF se rellenan automáticamente con los datos verificados durante el proceso de identificación, por lo que pueden omitirse.

Ejemplo con dos firmantes:

                       ["FIRMANTES": [
                          {
                            "Nombre":   "Pedro Aicart",
                            "NIF":      "00000000T",
                            "Email":    "pedro@dominio.com",
                            "Telefono": "34600000002",
                            "Orden":    1
                          },
                          {
                            "Nombre":   "Ana Aguado",
                            "NIF":      "00000001E",
                            "Telefono": "34600000001",
                            "Orden":    2
                          }
                        ]

NUEVO en v4. Array JSON para crear múltiples contratos independientes en una sola petición. Cada objeto del array genera un contrato.

Use este parámetro en lugar de FIRMANTES + PERSONALIZACION cuando necesite enviar el mismo documento a varias personas con variables personalizadas distintas. Si envía ENVIOS, los campos FIRMANTES y PERSONALIZACION de nivel raíz se ignoran.

Cada objeto en el array debe contener:
Firmantes : (Obligatorio) Array de firmantes para este contrato (misma estructura que el parámetro FIRMANTES de nivel raíz).
Variables : (Opcional) Objeto con pares clave/valor de variables sustituibles en plantillas y mensajes para este contrato concreto. Las claves se normalizan a minúsculas y se accederá a ellas en plantillas como {{nombrevariable}}.

Ejemplo: dos contratos con variables distintas

                       ["ENVIOS": [
                          {
                            "Firmantes": [
                              { "Nombre":"Juan García", "NIF":"11111111H", "Telefono":"34611111111", "Email":"juan@a.com", "Orden":1 }
                            ],
                            "Variables": { "importe":"100€", "plazo":"30 días" }
                          },
                          {
                            "Firmantes": [
                              { "Nombre":"Ana Pérez", "NIF":"22222222J", "Telefono":"34622222222", "Email":"ana@a.com", "Orden":1 }
                            ],
                            "Variables": { "importe":"250€", "plazo":"60 días" }
                          }
                        ]

La respuesta cuando se usa ENVIOS contiene un array Contratos con un objeto por cada contrato creado (con ContratoId, ReportID, Firmantes, Documentos).

Identificador de un flujo de trabajo previamente guardado en su panel. Tiene predefinidos documentos, plantillas, tipo de firma, etc. y basta con definir los firmantes en la petición.

Las variables de la petición prevalecen sobre las del flujo (ej. si en el flujo está TIPOFIRMA=ACEPTACION y en la petición envía TIPOFIRMA=BIOMETRICA, se usa BIOMETRICA). Excepción: DOCUMENTOS y FIRMASEMISOR son acumulativos (se añaden los del flujo a los de la petición).

Array JSON con las firmas de emisor (usted) guardadas en su cuenta que desea estampar sobre los documentos firmados. El sistema añade su firma y certificados al documento al final del proceso, completando el documento legal. Los recuadros donde se estampan se definen con STAMPFIRMAEMISOR/STAMPFIRMASEMISOR en cada documento PDF.

Cada elemento del array debe contener:
ID: Identificador de la firma manuscrita o certificada guardada en su cuenta. Lo encuentra en el panel.

Array JSON con la lista de documentos del contrato. Cada elemento representa un PDF, una plantilla del panel o una casilla de verificación.

Tipos soportados (campo Tipo):
  PLANTILLA : Plantilla creada en su panel. Requiere Plantilla, Nombre, Aceptacion.
  PDF : Fichero PDF en base64. Requiere Contenido, Nombre, Aceptacion. Opcionalmente StampFirmaEmisor/StampFirmaFirmante (singular legacy) o StampFirmasEmisor/StampFirmasFirmante (plural NUEVO v4).
  CHECKBOX : Pregunta al firmante (RGPD, etc.). Requiere Texto, Inicial, Final.

Campos comunes:
Tipo : PLANTILLA | PDF | CHECKBOX (Obligatorio)
Nombre : Nombre visible para el firmante (PLANTILLA y PDF).
TipoDoc : NUEVO v4. CONTRATO (default) o AUTORIZACION.
GrupoAut : NUEVO v4. 1, 2 o 3. Solo válido si TipoDoc=AUTORIZACION; indica en qué grupo secuencial debe revisarse este documento antes del contrato.

Campos para PLANTILLA:
Plantilla : ID de la plantilla del panel. Formato {idUsuario}-{idPlantilla}.
Aceptacion : SI (el firmante debe llegar al final con scroll) | NO (puede firmar sin scroll).

Campos para PDF:
Contenido : Contenido del PDF en base64.
Aceptacion : SI | NO (igual que PLANTILLA).
StampFirmaEmisor : (Singular legacy) Recuadro UNO de la firma del emisor. Formato: pag,x,y,tamx,tamy,H|V. Ej. 1,80,580,220,110,H.
StampFirmaFirmante : (Singular legacy) Recuadro UNO de la firma del firmante. Mismo formato.
StampFirmasEmisor : NUEVO v4. Array de strings — hasta 10 recuadros del emisor con el mismo formato que el singular.
StampFirmasFirmante : NUEVO v4. Array de strings — hasta 10 recuadros del firmante.

Formato de recuadro pag,x,y,tamx,tamy,H|V:
  pag : página (1-based).
  x : coordenada X del borde izquierdo (0 = borde izquierdo de la página).
  y : coordenada Y del borde superior (0 = borde superior de la página).
  tamx : ancho del recuadro.
  tamy : alto del recuadro.
  H | V : orientación de la página. V (vertical, default A4): max ancho 595, max alto 841. H (horizontal A4): max ancho 841, max alto 595.

Campos para CHECKBOX:
Texto : La pregunta o frase que verá el firmante.
Inicial : OFF (desactivada al cargar) | ON (activada al cargar).
Final : OFF (debe quedar desactivada para firmar) | ON (debe quedar activada) | LIBRE (el firmante decide).

Ejemplo: 2 autorizaciones (Grupo 1 y Grupo 2) + contrato con 2 recuadros firmante

                           ["DOCUMENTOS": [
                              {
                                "Tipo":     "PDF",
                                "Nombre":   "NDA Confidencialidad",
                                "Contenido":"JVBERi0xLj...",
                                "TipoDoc":  "AUTORIZACION",
                                "GrupoAut": 1
                              },
                              {
                                "Tipo":     "PDF",
                                "Nombre":   "Política de Privacidad RGPD",
                                "Contenido":"JVBERi0xLj...",
                                "TipoDoc":  "AUTORIZACION",
                                "GrupoAut": 2
                              },
                              {
                                "Tipo":       "PDF",
                                "Nombre":     "Contrato Principal",
                                "Contenido":  "JVBERi0xLj...",
                                "TipoDoc":    "CONTRATO",
                                "Aceptacion": "SI",
                                "StampFirmasFirmante": [
                                  "1,80,500,180,80,H",
                                  "2,80,500,180,80,H"
                                ],
                                "StampFirmasEmisor": [
                                  "1,320,500,180,80,H"
                                ]
                              }
                            ]

Array JSON con documentos que el firmante debe ADJUNTAR al firmar (ej. copia DNI, justificante, etc.). Cada elemento define un texto descriptivo y a qué firmante se le pide.

Coste fijo: PRECIO_FIJO_SOLICITUD_DOCUMENTOS (11 créditos).

Cada elemento debe contener:
Texto : Descripción del documento solicitado (ej. 'Adjunte copia de su DNI por las dos caras').
Firmante : 0 = a todos los firmantes; 1, 2, ... = al firmante con ese índice (1-based).

Variables sustituibles en plantillas y mensajes. Debe ser un string JSON con un objeto plano de pares clave/valor. Las claves se normalizan a minúsculas y se accede a ellas en plantillas como {{nombrevariable}} (o equivalentes [nombrevariable], (nombrevariable), ###nombrevariable###).

Si usa ENVIOS (multi-envío), defina las variables en Variables dentro de cada envío en lugar de aquí.

Tipo de firma a aplicar. IMPORTANTE: debe usar el TEXTO, no el número.

ACEPTACION : Firma por aceptación explícita (botón Acepto/Rechazo).
OTP : Firma con código OTP de un solo uso. Si no envía CANALESOTP, el OTP irá por SMS al móvil del firmante.
BIOMETRICA : Firma manuscrita biométrica (default).
CERTIFICADO : Firma con certificado electrónico o DNI electrónico del firmante.

Identificador del emisor (3-11 caracteres alfanuméricos). Usado en SMS legacy y como fallback si no especifica REMITENTE en cada canal SMS.

Legacy v3. Texto del SMS/Email cuando se usa MEDIOCOMUNICACION y NO se envía CANALESFIRMA. Ignorado si usa CANALESFIRMA (cada canal lleva su propio mensaje). Variables sustituibles: [NOMBRE], [NIF], [LINK], [TIPODOCUMENTO].

Legacy v3. Canal único de notificación. Se ignora si envía CANALESFIRMA; en su lugar use CANALESFIRMA para definir uno o varios canales.

SMS : Envío por SMS al móvil del firmante. Coste extra: PRO_CREDITOS_MENSAJE.
EMAIL : Envío por email (dominio por defecto del distribuidor). Sin coste extra.
SMSCERTIFICADO : SMS con certificación de entrega. Coste extra: CREDITOS_CERTIFICADO + CREDITOS_PARTE_CERTIFICADO.

Tipo de documento (texto libre, max 50 chars). Se sustituye en el placeholder [TIPODOCUMENTO] de los mensajes legacy. Default: 'Contrato'.

SI activa la verificación online de identidad antes de firmar (vídeo + DNI). Coste extra: VERIFICAR_IDENTIDAD (20 créditos por firmante). Requiere que su cuenta esté validada por soporte. Si SI, los campos Nombre y NIF de FIRMANTES son opcionales (se rellenan tras la verificación).

Referencia interna del integrador (max 200 chars). Se devuelve en los reports y permite asociar el contrato con su sistema externo. Acepta letras, dígitos, espacios y los caracteres . - _ ,

SI deja el contrato accesible para descarga futura tras la firma; NO bloquea acceso futuro tras la certificación. Default: SI.

SI permite que los recordatorios alternen canales (SMS y Email) si el firmante tiene ambos definidos; NO usa siempre el mismo canal. En v4 con CANALESFIRMA, la rotación es automática entre todos los canales del array, independientemente de este parámetro.

Número de recordatorios automáticos a enviar al firmante si no ha firmado (1-10). Cada recordatorio usa el siguiente canal de la cascada (rotación).

Fecha límite de firma en formato YYYY-MM-DD HH:mm. Mínimo: hoy + 1 hora. Máximo: hoy + 45 días. Default: mes siguiente, mismo día. Pasada esta fecha el contrato expira sin firma (estado 150).

Idioma de la interfaz que verá el firmante en la pantalla de firma. es (español, default) | pt (portugués).

Si hay CHECKBOXES en DOCUMENTOS, número mínimo de casillas que el firmante debe marcar para poder firmar. Entre 0 y el número total de checkboxes.

Si hay CHECKBOXES en DOCUMENTOS, número máximo de casillas que el firmante puede marcar. Debe ser ≥ MINIMOCHECK.

NUEVO v4. Mensaje informativo (max 1000 chars) que se muestra al firmante en una ventana emergente al llegar al primer documento de autorización. Útil para explicar al firmante qué va a revisar antes de firmar el contrato. Se ignora si no hay documentos con TipoDoc=AUTORIZACION.

Formato de la respuesta. Recomendado JSON para facilitar el parseo.

JSON : Objeto JSON.
XML : Documento XML.
TXT : Texto plano (default por compat legacy).

NUEVO en v4. Array JSON con la lista ordenada de canales por los que enviar la solicitud de firma. El sistema intentará el primero; si falla, pasará al siguiente automáticamente (cascada). Si configura recordatorios, cada uno usará el siguiente canal disponible (rotación).

Si NO incluye CANALESFIRMA, el sistema construye internamente un canal único a partir de los parámetros legacy MEDIOCOMUNICACION, MENSAJE y REMITENTE (compat v3). Es decir, no es obligatorio para mantener su integración v3 actual.

Cada elemento del array debe llevar el campo TIPO y los campos específicos de ese tipo:

SMS — campos:
  TIPO: "SMS"
  REMITENTE: (Opcional) Identificador del emisor del SMS, max 11 chars alfanum (default: 'FIRMA').
  MENSAJE: (Obligatorio) Texto del SMS. Debe contener {{LINK}} (o [LINK]) que se sustituirá por el enlace de firma.

EMAIL — campos:
  TIPO: "EMAIL"
  DOMINIO: (Obligatorio) Tiene dos modos:
    (A) Dominio propio — p.ej. su-dominio.com. Para usarlo es IMPRESCINDIBLE que ese dominio esté dado de alta y validado en el servicio de Email Transaccional de su panel (proceso DNS + verificación). Si el dominio no está validado el envío fallará con código -25. Esta opción permite que el destinatario reciba el email desde su marca y mejora la entregabilidad.
    (B) Dominio por defecto — token literal pordefecto. Usa el dominio genérico configurado por su distribuidor (típicamente contratos.distribuidor.com). NO requiere validación previa ni configuración. Úselo cuando no quiera/pueda validar dominio propio.
  REMITENTE: (Obligatorio si DOMINIO es un dominio propio, p.ej. su-dominio.com) Email completo del emisor; la parte tras @ DEBE coincidir EXACTAMENTE con DOMINIO. P.ej. si DOMINIO=su-dominio.com, REMITENTE debe ser algo@su-dominio.com. (Opcional si DOMINIO=pordefecto: si lo omite, el sistema usa el remitente por defecto del distribuidor.)
  IDPLANTILLA: (Obligatorio si DOMINIO es un dominio propio) ID numérico de la plantilla email transaccional creada en el panel; debe contener {{LINK}}. (Opcional con pordefecto: si lo omite, se usa la plantilla predeterminada del sistema con el cuerpo de MENSAJEEMAIL.)
  ASUNTOEMAIL: (Opcional) Asunto del email.
  MENSAJEEMAIL: (Opcional, recomendado solo si DOMINIO=pordefecto sin plantilla) Cuerpo libre del email cuando no usa una plantilla del usuario.

⚠ Recordatorio importante sobre el dominio Email: use SIEMPRE el token pordefecto para el dominio genérico del distribuidor. NO use otros tokens internos (como mensatek) — están deprecados para integradores nuevos y existen únicamente por compatibilidad con datos antiguos. Si va a enviar desde su propio dominio (su-dominio.com), valídelo primero en su panel » Email Transaccional » Dominios.

RCS — campos:
  TIPO: "RCS"
  IDAGENTE: (Obligatorio) ID del agente RCS configurado en el panel.
  IDPLANTILLA: (Obligatorio) ID de la plantilla RCS; debe contener {{LINK}}.
  REMITENTE: (Opcional) Nombre comercial mostrado al destinatario.

WHATSAPP — campos:
  TIPO: "WHATSAPP"
  IDTELEFONO: (Obligatorio) Phone Number ID de WhatsApp Business configurado en el panel.
  IDPLANTILLA: (Obligatorio) Nombre/ID de la plantilla WhatsApp aprobada en Meta. La plantilla DEBE incluir un botón URL apuntando a https://firma.ws/.
  VARSCUSTOM: (Opcional) Objeto con variables custom que la plantilla WhatsApp espera (ej. cabecera de imagen, etc.).

Ejemplo de cascada SMS → Email (dominio propio validado) → WhatsApp
Aquí su-dominio.com debe estar previamente validado en su panel de Email Transaccional. Si NO lo tiene validado y solo quiere enviar desde el dominio genérico del distribuidor, sustituya el bloque EMAIL por el del siguiente ejemplo (con pordefecto).

                       ["CANALESFIRMA": [
                          {
                            "TIPO":      "SMS",
                            "REMITENTE": "FIRMA",
                            "MENSAJE":   "Hola {{NOMBRE}}, firma aquí: {{LINK}}"
                          },
                          {
                            "TIPO":         "EMAIL",
                            "DOMINIO":      "su-dominio.com",          // dominio propio — DEBE estar validado
                            "REMITENTE":    "contratos@su-dominio.com", // parte tras @ ha de coincidir con DOMINIO
                            "IDPLANTILLA":  12345,                       // ID plantilla del panel; debe contener {{LINK}}
                            "ASUNTOEMAIL":  "Solicitud de firma"
                          },
                          {
                            "TIPO":        "WHATSAPP",
                            "IDTELEFONO":  "123456789012345",
                            "IDPLANTILLA": "firma_contrato_es"
                          }
                        ]

Variante con dominio por defecto del distribuidor (no requiere validación de DNS):

                          {
                            "TIPO":         "EMAIL",
                            "DOMINIO":      "__pordefecto__",  // dominio genérico del distribuidor (sin validación)
                            "ASUNTOEMAIL":  "Solicitud de firma",
                            "MENSAJEEMAIL": "Pulse aquí para firmar: {{LINK}}"
                          }

NUEVO en v4. Array JSON con los canales por los que enviar el código OTP (PIN de 5 dígitos) cuando TIPOFIRMA=OTP. La estructura es idéntica a CANALESFIRMA: cada elemento lleva TIPO y los campos específicos.

Diferencia clave: en plantillas y mensajes use {{CODE}} en lugar de {{LINK}}. La plantilla email/RCS/WhatsApp para OTP debe contener {{CODE}}.

Si TIPOFIRMA=OTP y NO incluye CANALESOTP, el sistema construye automáticamente un canal SMS al móvil del firmante con el mensaje 'Su código de verificación es: {{CODE}}'. Este es el comportamiento legacy v3 (el OTP siempre se enviaba por SMS).

Si quiere que el OTP llegue por Email/RCS/WhatsApp en lugar de SMS, defina CANALESOTP explícitamente.

Ejemplo: OTP por SMS y Email (dominio propio validado) simultáneamente
El bloque EMAIL usa su-dominio.com: ese dominio DEBE estar validado en su panel de Email Transaccional. Si no lo tiene validado, sustitúyalo por pordefecto (ver variante debajo).

                       ["CANALESOTP": [
                          {
                            "TIPO":      "SMS",
                            "REMITENTE": "FIRMA",
                            "MENSAJE":   "Tu código OTP es: {{CODE}}"
                          },
                          {
                            "TIPO":         "EMAIL",
                            "DOMINIO":      "su-dominio.com",         // dominio propio — DEBE estar validado
                            "REMITENTE":    "otp@su-dominio.com",     // parte tras @ ha de coincidir con DOMINIO
                            "IDPLANTILLA":  67890,                     // plantilla del panel; debe contener {{CODE}}
                            "ASUNTOEMAIL":  "Tu código OTP"
                          }
                        ]

Variante con dominio por defecto (sin validación):

                          {
                            "TIPO":         "EMAIL",
                            "DOMINIO":      "__pordefecto__",   // dominio genérico del distribuidor
                            "ASUNTOEMAIL":  "Tu código OTP",
                            "MENSAJEEMAIL": "Tu código es {{CODE}}"
                          }

ReportID devuelto en la función de envío.

ContratoID devuelto en la función de envío.

ReportID devuelto en la función de envío.

ContratoID devuelto en la función de envío.

Tipo de documento a descargar:
CERTIFICADO — Documento certificado completo con todos los eventos (siempre PDF).
FIRMANTE — Copia para firmantes (solo documento firmado con firmas estampadas). PDF si el contrato no tiene grupos de autorización; ZIP si los tiene (con un PDF por cada grupo + el PDF del contrato).