You can use this functionality to embed our proprietary e-sign in your workflow.INPORTANT: It is important to know that this functionality is applicable only on applications that have one principal owner, otherwise, use the standard Request E-sign endpoint.
To use this feature, the following steps need to be performed.1.
The following script must be added to the head of your page where you have integrated the boarding application process.
IMPORTANT: Before generating an embeded e-sign request it is always recommended to use our Validate endpoint to verify that all required application fields are filled, otherwise you won't be able to sign the application and will be presented with a validation error.
3. You need to implement the function from the library that is being loaded in step 1 to create the popup modal window. The function can be loaded on different events, click, submit, change, etc. based on your preference. The function has two parameters. The first is the JSON that you get from step 2, and the second is a callback function.The callback function is something that you need to create based on your preferences. There you can decide whether to have a redirect to your success pages with the signature parameter included in it or some other action.Here is what to expect as data for success in the callback function{
event: "sign",
boardingApplication: {
id: 1
},
principal: {
id : 1,
name: {
first: "John",
last: "Wick"
}
},
sign: {
id: 1,
status: "Signed"
}
}
sign.status= RejectedIf there are any errors in the callback you will receive the following data{
event: "exception",
name: "Bad Request",
message: "Wrong email",
code: 400,
status: 400
}
Modified at 2025-08-09 05:39:42
