| Firmantes required | Array of arrays Example: Firmantes=[{"Nombre":"Pedro Pérez","NIF":"00000000T","Email":"destinatario@eldominio.com"}] Array JSON con los datos de los firmantes. Dn el que se deben incluir lss siguientes variables:
Nombre : (Obligatorio) Nombre y apellidos del firmante
NIF : (Obligatorio) NIF/DNI del firmante
Email : (Opcional Email o Teléfono) Email del firmante. Debe definir Email o Teléfono oara cada firmante o puede definir ambos si desea enviar los recordatorios de firma de forma alternada entre SMS y Email.
Telefono : (Opcional Email o Teléfono) Teléfono del firmante. Debe definir Email o Teléfono oara cada firmante o puede definir ambos si desea enviar los recordatorios de firma de forma alternada entre SMS y Email.
Orden : (Opcional) Orden de firma para varios firmantes. Sólo necesario si se incluyen varios firmantes para el mismo documento/contrato.
Por ejemplo para dos firmantes:
[
{
"Nombre": "Pedro Aicart",
"NIF": "00000000T",
"Email": "pedro@dominio.com",
"Telefono": "34600000002",
"Orden": "1"
},
{
"Nombre": "Ana Aguado",
"NIF": "00000001E",
"Telefono": "34600000001",
"Orden": "2"
}
]
|
| Flujotrabajo | string Example: Flujotrabajo=238754787 Flujo de trabajo ya guardado en su cuenta y que desea reutilizar. Un flujo de trabajo se crea desde su panel de usuario al enviar contratos para firma, tiene predefinidos los documentos, plantillas, tipo de firma, etc... y basta con definir los destinatarios/firmantes para completar el proceso. Es muy útil en envíos de tipos de contrato de tipo repetitivo (plantillas de contrato como condiciones particulares, PDF en condiciones generales y una plantilla SEPA por ejemplo). La utilización de Flujos de trabajo sólo añade los valores definidos si no se envían en la petición, es decir, las variables normales , por ejemplo TipoFirma, prevalecen en la petición frente a la definida en el flujo de trabajo. Así, si en el flujo de trabajo ha definido ACEPTACION como modo de firma y en la petición API no se define, se utilizará ese tipo de firma pero, si , por ejemplo, en la petición define TipoFirma=BIOMETRICA, ésta prevalecerá(se utilizará) sobre la definida en el flujo de trabajo. Hay dos variables cuyo funcionamiento es distinto. DOCUMENTOS y FIRMASEMISOR añaden los documentos y firmas definidos tanto en el flujo de trabajo como en la petición. Estos parámetros, por tanto, son acumulativos.
|
| Firmasemisor | Array of arrays Example: Firmasemisor=[{"ID":1865998}] Array JSON con las firmas de emisor guardadas en su cuenta que desea 'imprimir' sobre las plantillas y documentos enviados tras la firma de los firmantes. El sistema, antes de la certificación añadirá su firma y certificados al documento completando el documento legal. Los recuadros de estampación de las firmas se definen en la variable documentos para PDFs y en la creación de plantillas en el panel de usuario para las Plantillas
Los parámetros a incluir en el array JSON son:
ID: Identificador de la firma manuscrita o certificada guardada en su cuenta que desea imprimir sobre los documentos y plantillas una vez el/los destinatarios hayan finalizado la firma. Puede añadir firmas de emisor y ver los identificadores en su panel de usuario.
|
| Documentos | Array of arrays Example: Documentos=[{"Tipo":"PLANTILLA","PLANTILLA":"120958967","ACEPTACION":"NO"}] Array JSON con el listado de documentos, plantillas y casillas de verificación que componen el contrato o acuerdo. Los parámetros a incluit en el array son:
Tipo:Tipo de documento a configurar. Puede ser PLANTILLA, PDF o CHECKBOX, en función del tipo, debe configurar los siguientes parámetros:
- PLANTILLA: Son plantillas creadas dentro del panel de usuario. Deben especificarse los parámetros Plantilla, Nombre y Aceptación (explicados a continuación)
- PDF: Son Ficheros PDF. Deben especificarse los parámetros Contenido, Nombre y Aceptación (explicados a continuación). Puede especificarse de forma opcional STAMPFIRMAEMISOR y STAMPFIRMAFIRMANTE que serían los recuadros donde quedarían incorporadas las firmas de emisor y/o firmante.
- CHECKBOX: Son preguntas que se realizan al firmante antes de la firma, por ejemplo para cumplimentar el reglamento GDPR, consultar sobre envío de ofertas, etc... Deben especificarse los parámetros Texto, Inicial y Final (explicados a continuación)
Nombre: Parámetro necesario para los TIPOS 'PLANTILLA' y 'PDF', es el Nombre del documento que verá el firmante.
Plantilla:Parámetro necesario en caso de TIPO PLANTILLA. Es el identificador de la Plantilla a incluir que puede encontrar en el listado de plantillas de contrato en su panel de usuario.
Aceptacion: Parámetro necesario para los TIPOS 'PLANTILLA' y 'PDF'. Especifica si el firmante debe ‘ver’ hasta el final del documento antes de firmar. Si es 1 el sistema pedirá al firmante que haga ‘scroll’ hasta el final del documento previamente a la firma.
Valores posibles:
- SI : El firmante debe ver hasta el final del documento antes de firmar.
- NO : El firmante puede firmar sin llegar al final de este documento o plantilla
Contenido: Parámetro necesario para el TIPO 'PDF'. Es el contenido en base64 del fichero PDF a firmar.
Texto: Parámetro necesario para el TIPO 'CHECKBOX'. Pregunta o texto que se le mostrará al firmante. Por ejemplo '¿Nos da su consentimiento expreso para la utilización de sus datos personales con el exclusivo propósito del perfeccionamiento del presente contrato?..
Inicial: Parámetro necesario para el TIPO 'CHECKBOX'. Estado inicial del checkbox/casilla de verificación. Valores posibles:
- OFF : desactivada
- ON : activada"
Final: Parámetro necesario para el TIPO 'CHECKBOX'. Estado final que debe tener la casilla. Valores posibles:
- OFF : debe estar desactivada,
- ON : debe quedar activada
- LIBRE : para elección libre.
StampFirmaEmisor: Parámetro opcional para el TIPO 'PDF'. Se define el recuadro del documento donde estampar la firma del emisor (Ud). El formato para definir el recuadro es Pag,x,y,tamx,tamy,orientacion, por ejemplo: 3,80,650,150,70,V que definirá el recuadro de firma para el emisor en la página 3 del PDF corrodenadas x 80 e y 650 y tamaños 150 de ancho y 70 de alto. la V final indica al sistema que el PDF tiene orientación vertical. Se asume que se trata de formato A4 y que el origen de coordenadas (0,0) empieza arriba a la izquierda y el tamaño máximo sería de 595 en x y 841 en y para horientación vertical y 841 en x y 595 en y si el documento tiene orientación horizontal.
- Pag : página donde se estampará la firma de emisor antes de la certificación,
- x : comienzo en x (0 en el borde izquierdo de la página) con un máximo de 595 en orientación vertical (la más habitual) y 841 para orientación horizontal
- y : comienzo en y (0 en el borde superior de la página) con un máximo de 841 en orientación vertical (la más habitual) y 595 para orientación horizontal
- tamx : ancho del recuadro de firma
- tamy : alto del recuadro de firma
- orient: orientación de las páginas, H para orientación horizontal y V para orientación vertical (la más habitual).
Ejemplo : 3,80,650,150,70,V que definirá el recuadro de firma para el emisor en la página 3 del PDF corrodenadas x 80 e y 650 y tamaños 150 de ancho y 70 de alto con el documento PDF en páginas A4 con orientación vertical.
StampFirmaFirmante: Parámetro opcional para el TIPO 'PDF'. Se define el recuadro del documento donde estampar la firma del firmante. El formato para definir el recuadro es Pag,x,y,tamx,tamy,orientacion, por ejemplo: 3,350,650,150,70,V que definirá el recuadro de firma para el firmante en la página 3 del PDF corrodenadas x 350 e y 650 y tamaños 150 de ancho y 70 de alto. la V final indica al sistema que el PDF tiene orientación vertical. Se asume que se trata de formato A4 y que el origen de coordenadas (0,0) empieza arriba a la izquierda y el tamaño máximo sería de 595 en x y 841 en y para horientación vertical y 841 en x y 595 en y si el documento tiene orientación horizontal.
- Pag : página donde se estampará la firma de emisor antes de la certificación,
- x : comienzo en x (0 en el borde izquierdo de la página) con un máximo de 595 en orientación vertical (la más habitual) y 841 para orientación horizontal
- y : comienzo en y (0 en el borde superior de la página) con un máximo de 841 en orientación vertical (la más habitual) y 595 para orientación horizontal
- tamx : ancho del recuadro de firma
- tamy : alto del recuadro de firma
- orient: orientación de las páginas, H para orientación horizontal y V para orientación vertical (la más habitual).
Ejemplo : 3,350,650,150,70,V que definirá el recuadro de firma para el firmante en la página 3 del PDF corrodenadas x 350 e y 650 y tamaños 150 de ancho y 70 de alto con el documento PDF en páginas A4 con orientación vertical.
|
| Documentossolicitados | Array of arrays Example: Documentossolicitados=[{"Texto":"Por favor, cargue o haga una foto del anverso de su DNI","Firmante":"0"}] Array JSON con el listado de documentos que se solicitan a uno o todos los firmantes, se puede elegir que cada firmante suba un documento distinto , que todos suban el mismo (por ejemplo el DNI de cada firmante) o cualquier combinación. Los parámetros a incluir por cada documento solicitado son:
Texto:Texgto que le aparecerá al/a los firmante/s cuando se les solcite el documento.
Firmante: Es el número de firmante al que se le va a solicitar el documento 0 para todos o 1,2,3... en función del número de firmante (identificado por el orden en el que se indican en el parámetro firmantes).
|
| Personalizacion | string Example: Personalizacion={
"Nombre_de_Empresa":”La empresa”,
"CIF":”B800000000”,
"Nombre_Apoderado":”Pedro Fernández”,
"Variable …":”Valor”,
}
Array JSON con los datos de personalización de las plantillas si se han añadido una o varias plantillas y se desea que se rellenen de forma automática, debe indicar aquí los valores de cada variable que quiera rellenar. Las variables de la/las plantilla/s que no indique/especifique en este parámetro deberán ser rellenadas por el primer firmante. Por ejemplo:
{
"Nombre_de_Empresa": "La empresa",
"CIF": "B800000000",
"Nombre_Apoderado": "Pedro Fernández",
"Variable_1": "Valor"
}
|
| Tipofirma | string Enum: 1 2 3 4 Example: Tipofirma=3 Es el tipo de firma que deberán utilizar los firmantes. Las opciones son:
ACEPTACION : Aceptación explícita
OTP : PIN OTP o PIN de un único uso (debe indicarse el móvil de los firmantes donde recibirán el PIN de firma)
BIOMETRICA : Firma manuscrita/biométrica: Cada firmante deberá realizar la firma dibujándola con el dedo sobre su propio teléfono móvil.
CERTIFICADO : Firma certificada: Se utilizará para la firma el certificado o DNI de cada firmante. Atención: Debe asegurarse de que los firmantes disponen de certificado de firma en sus dispositivos o lector de DNI.
|
| Remitente | string Example: Remitente=MiEmpresa Remitente de los SMS o SMS Certificados enviados para el perfeccionamiento del contrato. Es lo que recibirá en el móvil cada firmante como 'mensaje de...'. Por lo general se utiliza el nombre de la empresa emisora. Máximo 11 caracteres.
|
| Mensaje | string Example: Mensaje=MiEmpresa Es el mensaje que se le enviará a cada firmante con el link de firma. Se pueden utilizar variables (las que ha enviado con cada firmante) y debe incluir el tag [LINK] dentro del mensaje que se sustituirá por el link de firma. El valor por defecto de esta parámetro (si no se especifica) es: ‘A la Atención de [NOMBRE] con NIF [NIF], según lo acordado, le enviamos el contrato para su firma. Pulse en el siguiente link: [LINK] para comenzar el proceso.’
|
| Mediocomunicacion | string Enum: 1 2 3 Example: Mediocomunicacion=EMAIL Es el medio de comunicación que se utilizará en el mensaje de firma.
EMAIL : Por Email
SMS : Por SMS.
SMSCERTIFICADO : Por SMS Certificado (los recordatorios no se harán por este medio, sólo el primero de los mensajes)
|
| Tipodocumento | string Example: Tipodocumento=Contrato (Por defecto ‘Contrato’). String con el tipo de contrato que estamos enviando. Es lo que se le indica al/a los firmante/s que van a firmar. Por ejemplo puede ser ‘Acuerdo de conciliación’, ‘Contrato’, ‘Mandato Sepa’, ‘Declaración parte seguro’, ‘Cesión de poderes’, etc….No influye en la operativa, simplemente es lo que se le indica a los firmantes.
|
| Verificacionidentidad | string Enum: "NO" "SI" Example: Verificacionidentidad=NO (Por defecto NO) si se establece a 'SI', el sistema identificará mediante vídeo a cada firmante y certificará la identificación incluyendo validez del DNI, si la persona identificada es real (prueba de vida) y si la persona identificada es la del DNI. Para ello, el sistema hará un vídeo de la persona a identificar y le solicitará que muestre a la cámara el DNI. Los datos del DNI del primer firmante pueden utilizarse también para rellenar, de forma automática las plantillas incorporadas en el contrato. ATENCIÓN debe solicitar activación de este servicio ya que, por temas de privacidad, debemos validar la empresa que va a utilizar este servicio. Posibles valores:
NO : No se realizará la verificación de identidad de los firmantes
SI : Se realizará una verificacióm de identidad de cada firmante incorporando los resultados, imágenes de interés y validez al certificado final.
|
| Minparecidoverificacion | integer Example: Minparecidoverificacion=80 Es el mínimo parecido entre la persona identificada y su DNI para continuar el proceso de contrato automáticamente. En caso de que no se supere este umbral o que el proceso haya detectado algún problema (por ejemplo DNI Caducado) el sistema esperará a la validación en paneles para continuar con el proceso de firma. También recibirá automáticamente una petición a su script receptor de report con todos los datos del DNI y el resultado y validaciones.
|
| Referenciausuario | string Example: Referenciausuario=NombreFirmante-NombreEmpresa-DNI Referencia del usuario para el contrato. Sirve como referencia de usuario (lo recibirá dentro de los parámetros de las peticiones a su script de recepción de reports) y para buscar de foma cómoda cada contrato en los paneles.
|
| Accesible | string Enum: "NO" "SI" Example: Accesible=SI Indica si cada firmante tendrá acceso al documento firmado. Realmente tendrá acceso al certificado final con el documento firmado.
NO : Los firmantes no tendrán acceso a la descarga del contrato
SI : Los firmantes tendrán acceso a la descarga del contrato mediante el mismo link de firma.
|
| Alternamedios | string Enum: "NO" "SI" Example: Alternamedios=SI Si se establece en SI, le indica al sistema que alterne la comunicación entre SMS y Email en cada recordatorio de firma hasta que los firmantes hayan finalizado el proceso. De este modo, siempre que haya definido el Email y el Teléfono Móvil de cada firmante, el sistema enviará recordatorios de firma alternativamente por SMS y por Email consiguiendo así un incremento en las posibilidades de contacto si el destinatario/firmante tiene estropeado el móvil, apagado o no abre correo.
NO : El sistema sólo utilizará el medio de comunicación que se le indique
SI : El sistema alternará los medios de comunicación en los recordatorios hasta la firma o expiración del contrato.
|
| Recordatorios | integer Example: Recordatorios=3 Es el número de DÍAS entre recordatorios de firma (no el número total de recordatorios). Si cada firmante no ha finalizado el proceso, lo ha dejado a medias o no ha accedido aún, el sistema le envía cada X días un recordatorio para que finalice el proceso. Los recordatorios se envían hasta que el firmante finaliza el proceso o hasta la fecha indicada en FechaLimite: alcanzada la fecha límite no se envían más recordatorios y el contrato expira.
|
| Fechalimite | string Example: Fechalimite=2021-10-10 Es la fecha en la que el sistema dejará de enviar recordatorios si no se ha finalizado el proceso y cerrará el contrato como no firmado. ATENCIÓN: El contrato realmente expirará en cualquiera de estos eventos, el que suceda antes:
- Se alcanza la fecha límite sin que se haya finalizado el proceso.
- El Usuario ha cancelado el contrato desde la API o desde los paneles.
|
| Idioma | string Enum: "es" "pt" "en" Example: Idioma=es Es el idioma en el que se muestra el proceso de firma. Si necesita uno que no aparezca, contacte con nosotros. En estos momentos las posibilidades son:
- es : Español
- pt : Portugués
- en : Inglés
|
| Minimocheck | integer Example: Minimocheck=1 Si ha incluido CheckBoxes en los documentos es el número mínimo de ellos que debe activar cada firmante (ON) antes de continuar el proceso. La utilizdad de Mínimo y Máximo para checkboxes podría ser:
Ejemplo 1.- Caso en el que se trata de una votación firmada. Cada firmante debe elegir a uno y solo uno de las opciones (por ejemplo) mínimo y máximo se establecerían en 1 para que cada firmante eligiese a uno y solo un candidato.
Ejemplo 2.- Caso de solicitar preferencias por ejemplo, necesitaríamos supongamos entre 2 y 3 preferencias de cada firmante. definiríamos MINIMOCHECK a 2 y MAXIMOCHECK a 3.
Etc…
|
| Maximocheck | integer Example: Maximocheck=1 Si ha incluido CheckBoxes en los documentos es el número máximo de ellos que debe activar cada firmante (ON) antes de continuar el proceso.
|
| Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON Tipo de respuesta a mostrar como resultado de la llamada.
ANT - (Obsoleto). Se mantiene por compatibilidad con versiones anteriores
JSON - La respuesta la obtendrá en JSON
XML - La respuesta la obtendrá en XML
TXT - La respuesta la obtendrá en formato Texto
|