Skip to main content
API docs by Redocly

eNotaryLog API - Templating (2.0.0)

Download OpenAPI specification:Download

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

The eNotaryLog API

Notarization

Get RON template information by template id

Retrieves notarization template information given an template ID. This endpoint is used for retrieving the role ids, free text fields, and other information regarding a specific notarization template so that this information can be used to create an notarization session using a template.

path Parameters
id
required
string <uuid>

The ID of the notarization template to retrieve

Responses

Response samples

Content type
application/json
Example

No free text fields

{
  • "id": "8d976a23-b865-4fcd-9165-ddc0aedaf614",
  • "templateName": "Mortgage Agreement",
  • "roles": [
    ],
  • "freeTextFields": [ ]
}

Get RON templates in an organization

Retrieves list of RON templates for an organization.

query Parameters
limit
integer [ 1 .. 50 ]

Max number of RON templates 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: "id" "templateName" "createdAt"

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

search
string

The value provided here will be searched for in the templateName fields

Responses

Response samples

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

Templating

Get RON template information by template id

Retrieves notarization template information given an template ID. This endpoint is used for retrieving the role ids, free text fields, and other information regarding a specific notarization template so that this information can be used to create an notarization session using a template.

path Parameters
id
required
string <uuid>

The ID of the notarization template to retrieve

Responses

Response samples

Content type
application/json
Example

No free text fields

{
  • "id": "8d976a23-b865-4fcd-9165-ddc0aedaf614",
  • "templateName": "Mortgage Agreement",
  • "roles": [
    ],
  • "freeTextFields": [ ]
}

Get esign template information by template id

Retrieves esign template information given an template ID. This endpoint is used for retrieving the role ids, free text fields, and other information regarding a specific esign template so that this information can be used to create an esign session using a template.

path Parameters
id
required
string <uuid>

The ID of the esign template to retrieve

Responses

Response samples

Content type
application/json
Example

No free text fields

{
  • "id": "8d976a23-b865-4fcd-9165-ddc0aedaf614",
  • "templateName": "Mortgage Agreement",
  • "roles": [
    ],
  • "freeTextFields": [ ]
}

Create an esign using a predefined template

Creates an esign session from a predefined template

Request Body schema: application/json
Array of objects non-empty

array of template ids to use to create an esign session.

object

Notification preferences. If not provided, defaults to { email: true }

Array of objects

The "signers" that need to sign the esign document(s). Each need to be assigned a role. Two participants may not have the same role.

Responses

Request samples

Content type
application/json
Example
{
  • "templates": [
    ],
  • "participants": [
    ]
}

Get esign templates in an organization

Retrieves list of esign templates for an organization.

query Parameters
limit
integer [ 1 .. 50 ]

Max number of esign templates 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: "id" "templateName" "createdAt"

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

search
string

The value provided here will be searched for in the templateName fields

Responses

Response samples

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

Get RON templates in an organization

Retrieves list of RON templates for an organization.

query Parameters
limit
integer [ 1 .. 50 ]

Max number of RON templates 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: "id" "templateName" "createdAt"

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

search
string

The value provided here will be searched for in the templateName fields

Responses

Response samples

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

Esign

Get esign template information by template id

Retrieves esign template information given an template ID. This endpoint is used for retrieving the role ids, free text fields, and other information regarding a specific esign template so that this information can be used to create an esign session using a template.

path Parameters
id
required
string <uuid>

The ID of the esign template to retrieve

Responses

Response samples

Content type
application/json
Example

No free text fields

{
  • "id": "8d976a23-b865-4fcd-9165-ddc0aedaf614",
  • "templateName": "Mortgage Agreement",
  • "roles": [
    ],
  • "freeTextFields": [ ]
}

Create an esign using a predefined template

Creates an esign session from a predefined template

Request Body schema: application/json
Array of objects non-empty

array of template ids to use to create an esign session.

object

Notification preferences. If not provided, defaults to { email: true }

Array of objects

The "signers" that need to sign the esign document(s). Each need to be assigned a role. Two participants may not have the same role.

Responses

Request samples

Content type
application/json
Example
{
  • "templates": [
    ],
  • "participants": [
    ]
}

Get esign templates in an organization

Retrieves list of esign templates for an organization.

query Parameters
limit
integer [ 1 .. 50 ]

Max number of esign templates 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: "id" "templateName" "createdAt"

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

search
string

The value provided here will be searched for in the templateName fields

Responses

Response samples

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