Skip to main content
API docs by Redocly

eNotaryLog API (2.0.0)

Download OpenAPI specification:Download

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

The eNotaryLog API enables developers to build online notarization applications and integrations with ease. The API provides endpoints for creating and managing notarization sessions, verifying user identities, and retrieving notarization details.

notaries

Get Notary users in an Organization

Retrieve a list of notaries associated with the authenticated organization.

Authorizations:
Authorization
query Parameters
limit
integer [ 1 .. 50 ]

Max number of notaries to return. Default is 25 if not supplied. Maximum is 50.

offset
integer >= 0

Number of records to skip. Default is 0 if not supplied.

orderBy
string
Enum: "firstName" "lastName" "email"

The field to order the results by. Default is createdAt if not supplied

orderByDirection
string
Enum: "asc" "desc"

The direction to order the results by. Default is asc if not supplied

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "limit": 50,
  • "offset": 0,
  • "total": 2
}

Get Notaries in an Organization

Retrieve a list of notaries associated with the authenticated organization.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
[
  • {},
  • {
    }
]

documents

Upload documents

This endpoint allows users to upload one or more PDF documents for processing.

Authorizations:
Authorization
Request Body schema: multipart/form-data

List of PDF files to be uploaded

docId
required
string

id of the signer this tag is assigned to

gcsRefId
required
string

GCS storage location

Responses

Request samples

Content type
multipart/form-data
Example
{
  "file": "example1.pdf"
}

Response samples

Content type
application/json
[
  • {
    }
]

Convert supported file formats to PDF

This endpoint allows you to convert supported file formats (such as DOCX, PPTX, and XLSX) to PDF files.

Authorizations:
Authorization
Request Body schema: multipart/form-data

List of files to be converted to PDF format

files
required
Array of strings <binary> non-empty

Responses

users

Delete a user

Delete a user from your organization by providing their unique ID.

Authorizations:
Authorization
path Parameters
id
required
string

The unique ID of the user to be deleted

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string",
  • "detail": "string",
  • "help": "string"
}

Retrieve a user

Retrieve a user's details from your organization by providing their unique ID.

Authorizations:
Authorization
path Parameters
id
required
string

The unique ID of the user to retrieve

Responses

Response samples

Content type
application/json
{
  • "total": 20,
  • "users": [
    ]
}

List users

Retrieve a list of all users in your organization.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List user roles

Retrieve all roles of a specific user in your organization.

Authorizations:
Authorization
path Parameters
id
required
string

The unique ID of the user whose roles to retrieve

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

notarizations

Retrieve notarization sessions

Get a list of notarization sessions created by the authenticated organization, filtered by the provided parameters.

Authorizations:
Authorization
query Parameters
status
required
string
Enum: "-" "pending_doc_upload" "pending_verification" "ready" "pending_start" "in_progress" "pending_payment" "complete_success" "complete_fail" "complete_terminated" "canceled"

Filter results by notarization status

limit
required
number
Example: limit=25

Number of results to return

offset
required
number

Number of results to skip

page
required
number
Example: page=1

Page number to return results for. If provided, then offset will be ignored

externalId
string
Example: externalId=7527b870-3f50-46dd-af85-80e8667d1e22

Filter by externalId provided at session creation via POST /notarizations. Does not have to be a UUID.

Responses

Create a new notarization session (Version 2)

Create a new notarization session for the authenticated organization with the provided request body, using the V2 API.

Authorizations:
Authorization
Request Body schema: application/json

Notarization session details

notarizationType
required
string (NotarizationType)
Enum: "ron" "rin" "ipen"
witnesses
number

consumer-provided external id

expiresAt
string <date-time>

consumer-provided external id

scheduleDate
string <date-time>

consumer-provided external id

required
object
Default: {}

Organization and notary to assign this notarization to

externalId
string

external id

required
object

Primary signer

required
Array of objects (Participant)

list of participants other than the primary signer

object

notification preferences

notificationEmails
Array of strings

Emails to send notification emails to. If notifyParticipants.email is true and notificationEmails is not supplied, emails will be sent to all participants.

required
Array of objects (Document)

List of documents

taggingOrganizationId
string

id of organization who will tag the documents

Responses

Request samples

Content type
application/json
{
  • "notarizationType": "ron",
  • "witnesses": 0,
  • "expiresAt": "2023-04-30T14:08:17.682Z",
  • "scheduleDate": "2023-04-21T14:08:17.682Z",
  • "assignTo": {
    },
  • "externalId": null,
  • "primarySigner": {
    },
  • "participants": [
    ],
  • "notifyParticipants": {
    },
  • "notificationEmails": [],
  • "documents": [
    ],
  • "taggingOrganizationId": null
}

Response samples

Content type
application/json
{ }

Get Notarization Details by ID

Retrieve the details of a specific notarization session by its unique ID, including the status, timestamp, and participant information.

Authorizations:
Authorization
path Parameters
id
required
string

Enter the unique ID of the notarization session.

Responses

Response samples

Content type
application/json
{
  • "id": "c8f7d342-ae5f-4bde-9976-8b091a89b234",
  • "status": "complete_success",
  • "createdAt": "2023-04-01T10:20:30Z",
  • "updatedAt": "2023-04-01T10:35:30Z",
  • "participants": [
    ]
}

ReplaceNotarySession

Authorizations:
Authorization
path Parameters
id
required
string
Request Body schema: application/json
notarizationType
required
string (NotarizationType)
Enum: "ron" "rin" "ipen"
witnesses
number

consumer-provided external id

expiresAt
string <date-time>

consumer-provided external id

scheduleDate
string <date-time>

consumer-provided external id

required
object
Default: {}

Organization and notary to assign this notarization to

externalId
string

external id

required
object

Primary signer

required
Array of objects (Participant)

list of participants other than the primary signer

object

notification preferences

notificationEmails
Array of strings

Emails to send notification emails to. If notifyParticipants.email is true and notificationEmails is not supplied, emails will be sent to all participants.

required
Array of objects (Document)

List of documents

taggingOrganizationId
string

id of organization who will tag the documents

Responses

Request samples

Content type
application/json
{
  • "notarizationType": "ron",
  • "witnesses": 0,
  • "expiresAt": "2023-04-30T14:08:17.682Z",
  • "scheduleDate": "2023-04-21T14:08:17.682Z",
  • "assignTo": {
    },
  • "externalId": null,
  • "primarySigner": {
    },
  • "participants": [
    ],
  • "notifyParticipants": {
    },
  • "notificationEmails": [],
  • "documents": [
    ],
  • "taggingOrganizationId": null
}

Response samples

Content type
application/json
{ }

Download Notarization Files

Download notarization files by ID. You can choose to download the original documents, completed documents, all documents, or the recorded video of the notarization session.

Authorizations:
Authorization
path Parameters
id
required
string

Enter the unique ID of the notarization session.

query Parameters
type
required
string
Enum: "original" "completed" "all" "recording"

Type of files to download: original documents, completed documents, all documents, or the recorded video.

Responses

Cancel a Notarization Session

Cancel a notarization session by its unique ID and send notification emails to the signers informing them of the cancellation.

Authorizations:
Authorization
path Parameters
id
required
string
Example: c8f7d342-ae5f-4bde-9976-8b091a89b234

Enter the unique ID of the notarization session to be canceled.

Request Body schema: application/json
notifyParticipants
boolean

send notification to signers?

Responses

Request samples

Content type
application/json
{
  • "notifyParticipants": true
}

Response samples

Content type
application/json
{ }

Send Verification Email to Signer

Send a verification email to the specified signer of a notarization session.

Authorizations:
Authorization
path Parameters
id
required
string
Example: c8f7d342-ae5f-4bde-9976-8b091a89b234

Enter the unique ID of the notarization session.

signerId
required
string
Example: 7ed1b6dd-6c7f-411e-9627-8286d27c6e2d

Enter the unique ID of the signer to whom the verification email will be sent.

Responses

esignatures

Cancel an esign session

Will cancel an esign session regardless of status and send emails to all participants

Authorizations:
Authorization
path Parameters
id
required
string
Example: c8f7d342-ae5f-4bde-9976-8b091a89b234

The esign id OR transaction id

Request Body schema: application/json

Any extraneous data to include in audit-trail

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json

esign session successfully canceled

{
  • "id": "c8f7d342-ae5f-4bde-9976-8b091a89b234",
  • "transactionId": "c8f7d342-ae5f-4bde-9976-8b091a89b234"
}

Resend the esign session email to participants

Will resend esign session emails to the participant ids given in the payload

Authorizations:
Authorization
path Parameters
id
required
string
Example: c8f7d342-ae5f-4bde-9976-8b091a89b234

The esign id OR transaction id

Request Body schema: application/json

Any extraneous data to include in audit-trail

signerIds
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "signerIds": [
    ]
}

Response samples

Content type
application/json

esign session emails successfully sent

{
  • "id": "c8f7d342-ae5f-4bde-9976-8b091a89b234",
  • "transactionId": "c8f7d342-ae5f-4bde-9976-8b091a89b234",
  • "signerIds": [
    ]
}

Given an esign id, get the transaction information

Will return the transaction information for the given esign id

Authorizations:
Authorization
path Parameters
id
required
string <uuid>
Example: c8f7d342-ae5f-4bde-9976-8b091a89b234

The esign id

Responses

Response samples

Content type
application/json

transaction successfully found

{
  • "id": "b8f7d342-ae5f-4bde-9976-8b091a89b234",
  • "organizationId": "a9f7d342-ae5f-4bde-9976-8b091a89b234",
  • "externalId": "19f7d342-ae5f-4bde-9976-8b091a89b234",
  • "documents": [
    ],
  • "participants": [
    ]
}

Create an eSignature Transaction

This endpoint creates a new eSignature transaction, which represents a set of documents that need to be signed by one or more recipients. A transaction is the top-level container for managing the eSignature process. Authorization (http bearer token) is required.

Authorizations:
Authorization
Request Body schema: application/json
externalId
string <uuid>

optional reference id for use by external systems for referring to this session

required
Array of objects (SessionDocument)

List of documents

required
Array of objects (EsignParticipant)

list of participants to include in esign session

object

notification preferences

status
required
string
Enum: "draft" "esign_pending"
referenceId
required
string

The unique identifier your organization assigned to this transaction.

signingOrder
boolean

The flag to enable signing order.

personalizedMessage
string

The personalized message to the email request sent to the client.

Responses

Request samples

Content type
application/json
{
  • "taggingOrganizationId": "org_7guaGbXG2Cf0QjMQ",
  • "taggingUserId": "475820c2-7364-4bf8-8c46-a435aaeffb1",
  • "documents": [
    ],
  • "participants": [
    ],
  • "status": "draft",
  • "personalizedMessage": "Dear Client, please review and sign the attached documents at your earliest convenience. Thank you."
}

Response samples

Content type
application/json
{
  • "taggingOrganizationId": "org_7guaGbXG2Cf0QjMQ",
  • "evault": "eOriginal",
  • "sendFinalEnoteTo": [ ],
  • "documents": [
    ],
  • "participants": [
    ]
}

Retrieve eSignature transaction details by ID

This endpoint retrieves a specific eSignature transaction by its ID. Authorization (HTTP bearer token) is required.

Authorizations:
Authorization
path Parameters
id
required
string

The unique identifier of the eSignature transaction.

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Update eSignature transaction

This endpoint will replace an eSignature transaction's data. Authorization (HTTP bearer token) required.

Authorizations:
Authorization
path Parameters
id
required
string

The unique identifier of the eSignature transaction.

Request Body schema: application/json

The updated transaction data.

externalId
string <uuid>

optional reference id for use by external systems for referring to this session

required
Array of objects (SessionDocument)

List of documents

required
Array of objects (EsignParticipant)

list of participants to include in esign session

object

notification preferences

status
required
string
Enum: "draft" "esign_pending"
referenceId
required
string

The unique identifier your organization assigned to this transaction.

signingOrder
boolean

The flag to enable signing order.

personalizedMessage
string

The personalized message to the email request sent to the client.

Responses

Request samples

Content type
application/json
{
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "documents": [
    ],
  • "participants": [
    ],
  • "notifyParticipants": {
    },
  • "status": "draft",
  • "referenceId": "string",
  • "signingOrder": false,
  • "personalizedMessage": false
}

Response samples

Content type
application/json
{
  • "taggingOrganizationId": "org_7guaGbXG2Cf0QjMQ",
  • "evault": "eOriginal",
  • "sendFinalEnoteTo": [ ],
  • "documents": [
    ],
  • "participants": [
    ]
}

Retrieve eSignature transactions by status

This endpoint retrieves a list of eSignature transactions filtered by the provided status. Authorization (HTTP bearer token) is required.

Authorizations:
Authorization
path Parameters
status
required
string

The status of the eSignature transactions to be retrieved (e.g., 'pending', 'completed', 'canceled').

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download documents for an eSignature transaction

This endpoint returns a ZIP file of documents associated with a specific eSignature transaction. The documents can be of all types, completed documents, or the original documents. Authorization (HTTP bearer token) is required.

Authorizations:
Authorization
path Parameters
id
required
string

The unique identifier of the eSignature transaction.

query Parameters
type
required
string
Enum: "all" "completed" "original"
Example: type=all

The type of documents to be retrieved: 'all', 'completed', or 'original'.

Responses

Webhook Events

Retry failed webhook calls

Retriggers any failed webhook calls that have exhausted their retry attempts.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
{
  • "jobIds": [
    ]
}