Skip to main content
API docs by Redocly

eNotaryLog API - Markup Room (2.0.0)

Download OpenAPI specification:Download

eNotaryLog Support Team: [email protected] URL: https://enotarylog.com/support

The markup room allows for marking up a document prior to session creation. The user can generate a URL and navigate to it in the browser to add participants and tags. Then upon submission, a eSign/RON session will be created.

Embedding in an iframe

The markup room URL can be embedded in an iframe. When the user has marked up the document and the data is submitted, the iframe will emit to the parent window the following via postMessage.

  window.parent.postmessage({ status: 'completed', id: '8d976a23-b865-4fcd-9165-ddc0aedaf614' });

The parent application will need to listen for messages from the iframe via the following

  window.addEventListener('message', async (e) => {
    try {
      const data = JSON.parse(e.data);
      if (dasa.status === 'completed') {
        // eSign successfully created
      }
    } catch (err) {
      // noop
    }
  }, false);

esign

Create a Markup Room

This endpoint is used to create a Markup Room URL with specified ui configuration, participants, and documents. Visiting the generated URL will allow for adding tags to the provided documents before creating a esign session.

Authorizations:
Authorization
Request Body schema: application/json
redirectUrl
string

If specified, the markup room will redirect back to this url after the session is has been successfully created. This URL should be specified if your platform will redirect the user to the markup-room instead of rendering the markup room in an iframe.

object (NotifyParticipants)

This configuration specifies the notification preferences when the session is created.

object (MarkupRoomConfig)

This field determines which UI elements are enabled/disabled for the generated URL returned by this endpoint

Array of objects (MarkupRoomParticipant) >= 0 items

If empty, then participant will be added in the markup room (must not set config.participants.add=false, its default value is true)

Array of MarkupRoomDocumentObject (object) or GcsRefId (string) (MarkupRoomDocument) >= 0 items

If empty, then documents will be added in the markup room. If values are supplied then valid pdf files must exist at the location specified as elements of this array. These values can be obtained by uploading pdf the file(s) to POST /documents/upload endpoint.

senderId
required
string <uuid> (SenderId) ^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4...

The user id of the individual creating the markup room url. This user must belong to the organization that the access token (sent in authorization header) was issue for.

externalId
string

optional external reference id for use by external systems to refer to the session created from this markup room.

Responses

Request samples

Content type
application/json
Example
{
  • "senderId": "8d976a23-b865-4fcd-9165-ddc0aedaf614"
}

Response samples

Content type
application/json

Markup room URL success response

{}

Get markup room data

This endpoint is used to fetch the Markup Room data by markup room configuration id. The data is used by consumers to fetch the url associated with a markup room id, and the configuration the markup room was created with.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json

Get markup room data success response

{
  • "url": "https://markup.enotarylog.com/markup-room/fb899ced-14ee-4896-9918-8d05f74ff4a9",
  • "config": {
    },
  • "documents": [
    ],
  • "participants": []
}