eSign Settings

The eSign settings are defined in JSON format as key-value pairs. The following settings are available:

JSON Key Description
SourceEntityName

The entity associated with the business workflow (digital journey) that calls the ESign process.

Needed only if the ESign process is used on an edit form (to alter an existing record) to update the workflow entity's business status after the signing (see businessStatusSuccess and businessStatusFail).
DestinationEntityName The name of the entity on which the E-sign results are mapped.
SourceLookupDestinationName The name of the SourceEntityName lookup key that points to DestinationEntityName. This is the source entity of the user journey from which the automation processor gathers data. If they are the same entity, enter the primary key.
fileAttributeName The name of the attribute on the entity which will store the file to be signed.
maxRetry

The maximum number of signing attempts.

If this number of failed signing attempts is reached, the user will be redirected according to the specifications in the maskNextStepUrlFail.
SignedDocumentName The name of the attribute which will store the signed file.
order The order of the signatures from the workflow. They can be sent in parallel.
signatureTag Marks the place where the signature will be done in the PDF file. It is a tag within the document to be signed on which customers will click to sign.
signatureTypeTemplate The signature type. This setting cannot be null, but can be an empty string if there is no specific signature type required.
checkCertificate Checks whether or not the client has a valid certificate.
fileToBeSignedName The name of the file that has to be signed.
languageCode The code of the language used for the signature. For information on how to add a new language, see the FintechOS Studio User Guide, section Adding New Languages.
email The attribute that stores the email provided by the customer. The email address of the customer where the document to be signed will be sent to.
phoneMobile The attribute which stores the phone number provided by the customer. It is the phone number that will receive the “textMessage” provided in the eSign Settings attribute.
prefixPhoneMobile The attribute that stores the country prefix of the mobile phone number provided by the customer.
firstName First Name of the customer.
lastName Last Name of the customer.
countryResidence The attribute which stores the country code where the customer has residence.
documentType The type of the document processed by the OCR processor if customer data has been gathered using an OCR automation processor.
documentIssuedBy Country/ Institution that issued the document.
socialSecurityNumber The name of the attribute that maps the customer’s social security number. For example, CNP for Romania and SSN for other countries. If on an entity, this info is stored in an attribute called PIN, then put PIN here.
documentExpiryDate The name of the attribute which stores the expiration date of the contract.
documentIssuedOn The name of the attribute which stores date when the document to be signed is issued.
documentNumber The name of the attribute which stores the number of the identity document.
smsConfiguration The name of attribute that stores the text that is sent to the specified mobile phone number. Supported only for Qualified Electronig Signature & OTP Signature types.
  • Text: the text body to be sent.
    - for QES it needs to contain the {tId} parameter placed inside the text message. When sent, it is replaced with transaction ID.
    - for OTP it needs to contain the {tId} and the {Token} parameters placed inside the text message. When sent, they are replaced with the corresponding transaction ID and Token value.
  • LanguageCode: The language code corresponding to the SignatureSteps.
clickMsg The name of the attribute that stores the message displayed to the person that is responsible to sign the document.
maskNextStepUrlSuccess Location in the user interface where the user is redirected after a successful scan.
  • entity – Entity name.
  • form – Form name of the above entity.
  • step – Optional parameter for the step name of the above form.
The step can be specified using the name of the step or the step’s number. Example "step": "Personal Data" and "step": "1" are both valid.
maskNextStepUrlFail Location in the user interface where the user is redirected after the maximum number of failed scan attempts (see maxRetry).
  • entity – Entity name.
  • form – Form name of the above entity.
  • step – Optional parameter for the step name of the above form.
The step can be specified using the name of the step or the step’s number. Example "step": "Personal Data" and "step": "1" are both valid.
businessStatusSuccess Indicates that the contract has been signed.
businessStatusFail Indicates that the contract has been rejected.
DisableLogSDKMessages
 Set this property to true if you do not wish to retain SDK logs.
LogLevel
 Controls the minimum severity level for the logged messages. Set it to error to capture only SDK errors or to debug to include all SDK log messages.
DisableSaveBrowserDetails
 Set this property to true to prevent storage of user platform details in the FTOS_DFP_Logging entity.
UseCustomWebhookTrigger Set this property to true to disable the automation block's default download webhooks. Users can implement custom webhooks via event triggered automation scripts.
ExpirationDate Sets the envelope expiration to a specific time, calculated as a fixed number of days after the current date.
  • The Days value determines how many days to add to the current date.
  • The Time value sets the exact time of expiration on the resulting date.
  • A value of 0 for Days means the expiration occurs on the current day at the specified time.
Examples (assuming the current date is October 24th):
  • "ExpirationDate": {"Days": 0, "Time": "23:59"} sets the expiration date to 2025-10-24T23:59
  • "ExpirationDate": {"Days": 1, "Time": "00:00"} sets the expiration date to 2025-10-25T00:00
  • "ExpirationDate": {"Days": 3, "Time": "14:50"} sets the expiration date to 2025-10-27T14:50

Examples

Copy 
{ 
        "DestinationEntityName": "FTOS_BNKAP_RetailApplicantData", 
        "SourceEntityName": "FTOS_BARET_AccountApplication", 
        "SourceLookupDestinationName": "retailApplicantId", 
        "FileAttributeName": "contract", 
        "fileToBeSignedName": "esign.pdf", 
        "MaxRetry": 3, 
        "signedDocumentName": "signedContract", 
        "SignatureSteps": [{
          "order": "1", 
          "signatureTag": "#esaw#", 
          "signatureTypeTemplate": "",
          "SignatureData": [{
            "languageCode":"EN", 
            "email": "email", 
            "phoneMobile": "mobilePhone", 
            "firstName": "firstName", 
            "lastName": "lastName", 
            "countryResidence": "RO", 
            "documentType":"CI", 
            "documentIssuedBy":"IdIssueInstitution", 
            "socialSecurityNumber": "PIN", 
            "documentExpiryDate": "IdExpirationDate", 
            "documentIssuedOn": "IdIssueDate", 
            "documentNumber": "IdCardSeries",
            "OverrideHolderMismatch": true/false,
          }],
          "smsConfiguration": { "Text": "your text goes here, to sign transaction {tId} use the following code: ", "LanguageCode": "" // RO, EN }
          "clickMsg": "Click here to sign",
        }],        
        "maskNextStepURLSuccess": { "entity":"FTOS_BARET_AccountApplication", "form": "FTOS_BARET_AccountApplication_UserJourney", "section": "Contract Successful " }, 
        "maskNextStepURLFail": { "entity": "FTOS_BARET_AccountApplication", "form": "FTOS_BARET_AccountApplication_UserJourney", "section": "Contract Fail " }, 
        "businessStatusSuccess": "Contract Signed", 
        "businessStatusFail": "Contract Rejected" 
}