Is called if documentType is "html" (see /settings). When the user opens the e-sign in Upsales, your page is shown in a full-screen window, where the user finalises the e-sign in your system and sends it to the recipient.

Endpoint
POST https://yourapp.com/iframe

The request is a POST with a JSON body, and your app's endpoint must use HTTPS.

Body
The body has the same fields as every app request (see Request body). body.data contains:

• name: esignDocument for e-sign. Upsales calls /iframe for every iframe your app shows, so use name to tell this request apart.
• typeId: editEsign.
• objectId: the ID of the e-sign in Upsales (see below).
• userId: the ID of the user who opened the e-sign.

body.data.objectId
Document id corresponding to e-sign in Upsales. Using this the integration can make a request to Upsales to get the full e-sign. On the e-sign object, the document ID can be found which you can use to open the correct e-sign in the iFrame.

Response
Respond within 30 seconds with status 200 or 201 and a JSON body with a runConfigs field. runConfigs is a string with the HTML that Upsales shows to the user, for example an iframe with the page where the user can edit and send their e-sign. If your app responds with any other status, without runConfigs, or does not respond in time, the user gets an error instead of your page.

Example response

{
    "runConfigs": "<iframe style=\"width: 100%; height: 100%; border: none;\" src=\"URL_TO_ESIGN\"></iframe>"
}