| Firmantes required | Array of arrays Example: Firmantes=[{"Nombre":"Pedro Pérez","NIF":"00000000T","Email":"destinatario@eldominio.com"}] JSON array with the data of the signers. In which the following variables must be included:
Nombre : (Mandatory) Name and surname of the signer
NIF : (Mandatory) NIF/DNI of the signer
Email : (Optional Email or Phone) Email of the signer. You must define Email or Phone for each signer or you can define both if you want to send signature reminders alternating between SMS and Email.
Telefono : (Optional Email or Phone) Phone of the signer. You must define Email or Phone for each signer or you can define both if you want to send signature reminders alternating between SMS and Email.
Orden : (Optional) Signature order for multiple signers. Only necessary if several signers are included for the same document/contract.
For example for two signers:
[
{
"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 A workflow already saved in your account that you want to reuse. A workflow is created from your user panel when sending contracts for signature, it has predefined the documents, templates, signature type, etc... and it is enough to define the recipients/signers to complete the process. It is very useful in repetitive type contract sends (contract templates such as particular conditions, PDF in general conditions and a SEPA template for example). The use of workflows only adds the defined values if they are not sent in the request, that is, the normal variables, for example TipoFirma, prevail in the request over the one defined in the workflow. Thus, if in the workflow you have defined ACEPTACION as signature mode and it is not defined in the API request, that signature type will be used but, if, for example, in the request you define TipoFirma=BIOMETRICA, this will prevail (be used) over the one defined in the workflow. There are two variables whose behavior is different. DOCUMENTOS and FIRMASEMISOR add the documents and signatures defined both in the workflow and in the request. These parameters are therefore cumulative.
|
| Firmasemisor | Array of arrays Example: Firmasemisor=[{"ID":1865998}] JSON array with the sender signatures saved in your account that you want to 'stamp' on the templates and documents sent after the signers' signature. The system, before certification, will add your signature and certificates to the document, completing the legal document. The signature stamping boxes are defined in the documents variable for PDFs and in the creation of templates in the user panel for Templates
The parameters to include in the JSON array are:
ID: Identifier of the handwritten or certified signature saved in your account that you want to stamp on the documents and templates once the recipient(s) have finished signing. You can add sender signatures and view the identifiers in your user panel.
|
| Documentos | Array of arrays Example: Documentos=[{"Tipo":"PLANTILLA","PLANTILLA":"120958967","ACEPTACION":"NO"}] JSON array with the list of documents, templates and check boxes that make up the contract or agreement. The parameters to include in the array are:
Tipo:Type of document to configure. It can be PLANTILLA, PDF or CHECKBOX, depending on the type, you must configure the following parameters:
- PLANTILLA: These are templates created within the user panel. The Plantilla, Nombre and Aceptacion parameters must be specified (explained below)
- PDF: These are PDF files. The Contenido, Nombre and Aceptacion parameters must be specified (explained below). You can optionally specify STAMPFIRMAEMISOR and STAMPFIRMAFIRMANTE which would be the boxes where the sender and/or signer signatures would be incorporated.
- CHECKBOX: These are questions asked to the signer before signing, for example to comply with the GDPR regulation, ask about sending offers, etc... The Texto, Inicial and Final parameters must be specified (explained below)
Nombre: Parameter required for the TYPES 'PLANTILLA' and 'PDF', it is the Name of the document that the signer will see.
Plantilla:Parameter required in case of TYPE PLANTILLA. It is the identifier of the Template to include that you can find in the contract template list in your user panel.
Aceptacion: Parameter required for the TYPES 'PLANTILLA' and 'PDF'. Specifies whether the signer must 'see' to the end of the document before signing. If it is 1 the system will ask the signer to 'scroll' to the end of the document prior to signing.
Possible values:
- SI : The signer must see to the end of the document before signing.
- NO : The signer can sign without reaching the end of this document or template
Contenido: Parameter required for the TYPE 'PDF'. It is the base64 content of the PDF file to be signed.
Texto: Parameter required for the TYPE 'CHECKBOX'. Question or text that will be shown to the signer. For example '¿Do you give us your express consent for the use of your personal data with the exclusive purpose of perfecting this contract?..
Inicial: Parameter required for the TYPE 'CHECKBOX'. Initial state of the checkbox/check box. Possible values:
- OFF : deactivated
- ON : activated"
Final: Parameter required for the TYPE 'CHECKBOX'. Final state that the box must have. Possible values:
- OFF : must be deactivated,
- ON : must remain activated
- LIBRE : for free choice.
StampFirmaEmisor: Optional parameter for the TYPE 'PDF'. The box in the document where the sender's (your) signature is stamped is defined. The format to define the box is Pag,x,y,tamx,tamy,orientation, for example: 3,80,650,150,70,V which will define the signature box for the sender on page 3 of the PDF, coordinates x 80 and y 650 and sizes 150 wide and 70 high. The final V indicates to the system that the PDF has vertical orientation. It is assumed that it is A4 format and that the coordinate origin (0,0) starts at the top left and the maximum size would be 595 in x and 841 in y for vertical orientation and 841 in x and 595 in y if the document has horizontal orientation.
- Pag : page where the sender's signature will be stamped before certification,
- x : start in x (0 at the left edge of the page) with a maximum of 595 in vertical orientation (the most common) and 841 for horizontal orientation
- y : start in y (0 at the top edge of the page) with a maximum of 841 in vertical orientation (the most common) and 595 for horizontal orientation
- tamx : width of the signature box
- tamy : height of the signature box
- orient: orientation of the pages, H for horizontal orientation and V for vertical orientation (the most common).
Example : 3,80,650,150,70,V which will define the signature box for the sender on page 3 of the PDF, coordinates x 80 and y 650 and sizes 150 wide and 70 high with the PDF document in A4 pages with vertical orientation.
StampFirmaFirmante: Optional parameter for the TYPE 'PDF'. The box in the document where the signer's signature is stamped is defined. The format to define the box is Pag,x,y,tamx,tamy,orientation, for example: 3,350,650,150,70,V which will define the signature box for the signer on page 3 of the PDF, coordinates x 350 and y 650 and sizes 150 wide and 70 high. The final V indicates to the system that the PDF has vertical orientation. It is assumed that it is A4 format and that the coordinate origin (0,0) starts at the top left and the maximum size would be 595 in x and 841 in y for vertical orientation and 841 in x and 595 in y if the document has horizontal orientation.
- Pag : page where the sender's signature will be stamped before certification,
- x : start in x (0 at the left edge of the page) with a maximum of 595 in vertical orientation (the most common) and 841 for horizontal orientation
- y : start in y (0 at the top edge of the page) with a maximum of 841 in vertical orientation (the most common) and 595 for horizontal orientation
- tamx : width of the signature box
- tamy : height of the signature box
- orient: orientation of the pages, H for horizontal orientation and V for vertical orientation (the most common).
Example : 3,350,650,150,70,V which will define the signature box for the signer on page 3 of the PDF, coordinates x 350 and y 650 and sizes 150 wide and 70 high with the PDF document in A4 pages with vertical orientation.
|
| Documentossolicitados | Array of arrays Example: Documentossolicitados=[{"Texto":"Por favor, cargue o haga una foto del anverso de su DNI","Firmante":"0"}] JSON array with the list of documents requested from one or all signers, you can choose that each signer uploads a different document, that all upload the same one (for example each signer's DNI) or any combination. The parameters to include for each requested document are:
Texto:Text that will appear to the signer(s) when the document is requested from them.
Firmante: It is the number of the signer from whom the document will be requested, 0 for all or 1,2,3... depending on the signer number (identified by the order in which they are indicated in the firmantes parameter).
|
| Personalizacion | string Example: Personalizacion={
"Nombre_de_Empresa":”La empresa”,
"CIF":”B800000000”,
"Nombre_Apoderado":”Pedro Fernández”,
"Variable …":”Valor”,
}
JSON array with the customization data of the templates if one or several templates have been added and you want them to be filled in automatically, you must indicate here the values of each variable you want to fill in. The variables of the template(s) that you do not indicate/specify in this parameter must be filled in by the first signer. For example:
{
"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 It is the signature type that the signers must use. The options are:
ACEPTACION : Explicit acceptance
OTP : OTP PIN or single-use PIN (the mobile of the signers where they will receive the signature PIN must be indicated)
BIOMETRICA : Handwritten/biometric signature: Each signer must perform the signature by drawing it with their finger on their own mobile phone.
CERTIFICADO : Certified signature: The certificate or DNI of each signer will be used for the signature. Attention: You must make sure that the signers have a signature certificate on their devices or a DNI reader.
|
| Remitente | string Example: Remitente=MiEmpresa Sender of the SMS or Certified SMS sent to perfect the contract. It is what each signer will receive on their mobile as 'message from...'. Generally the name of the issuing company is used. Maximum 11 characters.
|
| Mensaje | string Example: Mensaje=MiEmpresa It is the message that will be sent to each signer with the signature link. Variables can be used (those you have sent with each signer) and you must include the tag [LINK] within the message which will be replaced by the signature link. The default value of this parameter (if not specified) is: 'To the Attention of [NOMBRE] with NIF [NIF], as agreed, we send you the contract for your signature. Click on the following link: [LINK] to start the process.'
|
| Mediocomunicacion | string Enum: 1 2 3 Example: Mediocomunicacion=EMAIL It is the communication medium that will be used in the signature message.
EMAIL : By Email
SMS : By SMS.
SMSCERTIFICADO : By Certified SMS (reminders will not be done by this medium, only the first of the messages)
|
| Tipodocumento | string Example: Tipodocumento=Contrato (Default 'Contrato'). String with the type of contract we are sending. It is what the signer(s) who are going to sign are told. For example it can be 'Settlement agreement', 'Contract', 'SEPA Mandate', 'Insurance claim statement', 'Power of attorney assignment', etc….It does not influence the operation, it is simply what the signers are told.
|
| Verificacionidentidad | string Enum: "NO" "SI" Example: Verificacionidentidad=NO (Default NO) if set to 'SI', the system will identify each signer via video and will certify the identification including DNI validity, whether the identified person is real (liveness test) and whether the identified person is the one in the DNI. To do this, the system will make a video of the person to be identified and will ask them to show the DNI to the camera. The DNI data of the first signer can also be used to automatically fill in the templates incorporated in the contract. ATTENTION you must request activation of this service since, for privacy reasons, we must validate the company that is going to use this service. Possible values:
NO : Identity verification of the signers will not be performed
SI : An identity verification of each signer will be performed, incorporating the results, images of interest and validity into the final certificate.
|
| Minparecidoverificacion | integer Example: Minparecidoverificacion=80 It is the minimum similarity between the identified person and their DNI to continue the contract process automatically. In case this threshold is not exceeded or the process has detected some problem (for example Expired DNI) the system will wait for validation in panels to continue with the signature process. You will also automatically receive a request to your report receiving script with all the DNI data and the result and validations.
|
| Referenciausuario | string Example: Referenciausuario=NombreFirmante-NombreEmpresa-DNI User reference for the contract. It serves as a user reference (you will receive it within the parameters of the requests to your report reception script) and to conveniently search for each contract in the panels.
|
| Accesible | string Enum: "NO" "SI" Example: Accesible=SI Indicates whether each signer will have access to the signed document. Actually they will have access to the final certificate with the signed document.
NO : The signers will not have access to download the contract
SI : The signers will have access to download the contract through the same signature link.
|
| Alternamedios | string Enum: "NO" "SI" Example: Alternamedios=SI If set to SI, it tells the system to alternate the communication between SMS and Email in each signature reminder until the signers have finished the process. In this way, as long as you have defined the Email and the Mobile Phone of each signer, the system will send signature reminders alternately by SMS and by Email, thus achieving an increase in the contact possibilities if the recipient/signer has a broken mobile, turned off or does not open email.
NO : The system will only use the communication medium indicated to it
SI : The system will alternate the communication media in the reminders until the signature or expiration of the contract.
|
| Recordatorios | integer Example: Recordatorios=3 It is the number of DAYS between signature reminders (not the total number of reminders). If each signer has not finished the process, has left it halfway or has not yet accessed it, the system sends them a reminder every X days to finish the process. Reminders are sent until the signer finishes the process or until the date indicated in FechaLimite: once the deadline is reached no more reminders are sent and the contract expires.
|
| Fechalimite | string Example: Fechalimite=2021-10-10 It is the date on which the system will stop sending reminders if the process has not been finished and will close the contract as unsigned. ATTENTION: The contract will actually expire on any of these events, whichever happens first:
- The deadline date is reached without the process having been finished.
- The User has canceled the contract from the API or from the panels.
|
| Idioma | string Enum: "es" "pt" "en" Example: Idioma=es It is the language in which the signature process is displayed. If you need one that does not appear, contact us. At this moment the possibilities are:
- es : Spanish
- pt : Portuguese
- en : English
|
| Minimocheck | integer Example: Minimocheck=1 If you have included CheckBoxes in the documents it is the minimum number of them that each signer must activate (ON) before continuing the process. The utility of Minimum and Maximum for checkboxes could be:
Example 1.- Case in which it is a signed vote. Each signer must choose one and only one of the options (for example) minimum and maximum would be set to 1 so that each signer chooses one and only one candidate.
Example 2.- Case of requesting preferences for example, we would need let's say between 2 and 3 preferences from each signer. We would define MINIMOCHECK to 2 and MAXIMOCHECK to 3.
Etc…
|
| Maximocheck | integer Example: Maximocheck=1 If you have included CheckBoxes in the documents it is the maximum number of them that each signer must activate (ON) before continuing the process.
|
| Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON Type of response to return as the result of the call.
ANT - (Obsolete). Maintained for compatibility with previous versions
JSON - The response will be returned in JSON
XML - The response will be returned in XML
TXT - The response will be returned in Text format
|