ESign

Investor Trade

ESign is used to notify signers, update signature packages, cancel signature packages and track the overall signature process.

API docs by Redocly

Trade eSign (v1)

Download OpenAPI specification:Download

Trade eSign

Used to invoke signing ceremony for the transactions that are ready to be electronically signed.

header Parameters
Authorization
required
string

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey
required
string

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Content-Type
required
string

Valid value is application/json. This defines the content type of the request payload accepted by the API.

Request Body schema: application/json
trackingNumber
string

Gets or sets the tracking number.

opportunityGroupID
string

Gets or sets the opportunityGroupId

hostName
string

Gets or sets the HostName

hostEmail
string

Gets or sets the HostEmail

Responses

Request samples

Content type
application/json
{
  • "trackingNumber": "string",
  • "opportunityGroupID": "string",
  • "hostName": "string",
  • "hostEmail": "string"
}

Response samples

Content type
application/json
"string"

Cancels an already In-progress signing ceremony by passing the Transaction Number or Group Opportunity Number

header Parameters
Authorization
required
string

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey
required
string

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body schema: */*
trackingNumber
string

A unique tracking number assigned to a specific request.

opportunityGroupId
string

Responses

Response samples

Content type
application/json
{
  • "trackingNumber": "string",
  • "opportunityGroupId": "string",
  • "userMessage": "string"
}

Resends signing notification to any signer’s email who is part of the transaction as needed

header Parameters
Authorization
required
string

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey
required
string

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Content-Type
required
string

Valid value is application/json. This defines the content type of the request payload accepted by the API.

Request Body schema: application/json
trackingNumber
string

A unique tracking number assigned to a specific request.

opportunityGroupId
string
email
string

The email address at which communications can be sent or received.

Responses

Request samples

Content type
application/json
{
  • "trackingNumber": "string",
  • "opportunityGroupId": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "trackingNumber": "string",
  • "opportunityGroupId": "string",
  • "email": "string",
  • "userMessage": "string"
}

Returns signer groups, signer information for each group and the information about transaction using an Inperson or remote signing.

path Parameters
trackingNumber
required
string

A unique tracking number assigned to a specific request.

header Parameters
Authorization
required
string

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey
required
string

This is the Consumer Key provided during the App Registration process and is used to identify the user's application

Responses

Response samples

Content type
application/json
{
  • "trackingNumber": "string",
  • "data": {
    }
}

Updates the signer information. If the signing ceremony has already started, then the ceremony has to be cancelled (DELETE endpoint) in order to update any signer information.

path Parameters
trackingNumber
required
string

A unique tracking number assigned to a specific request.

header Parameters
Authorization
required
string

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey
required
string

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

content-type
required
string

Valid value is application/json. This defines the content type of the request payload accepted by the API.

Request Body schema: */*
Array
required
object (EsignGroupInfo)

Responses

Response samples

Content type
application/json
{
  • "trackingNumber": "string",
  • "data": {
    }
}

Resends signing notification to any signer's email who is part of the transaction as needed

path Parameters
trackingNumber
required
string

A unique tracking number assigned to a specific request.

header Parameters
Authorization
required
string

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey
required
string

This is the Consumer Key provided during the App Registration process and is used to identify the user's application

content-type
required
string

Valid value is application/json. This defines the content type of the request payload accepted by the API.

Request Body schema: */*
Array
required
object (EsignGroupInfo)

Responses

Response samples

Content type
application/json
{
  • "trackingNumber": "string",
  • "data": {
    }
}

Returns the most updated esign status for the transaction

query Parameters
trackingNumber
string

A unique tracking number assigned to a specific request.

opportunityGroupId
string
header Parameters
Authorization
required
string

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey
required
string

This is the Consumer Key provided during the App Registration process and is used to identify the user's application

Responses

Response samples

Content type
application/json
{
  • "trackingNumber": "string",
  • "opportunityGroupId": "string",
  • "eSignStatus": "string",
  • "eSignerStatus": [
    ]
}

Subscribe to receive real time notifications whenever the esign status for signors changes for a given Tracking number or the Opportunity group. If either the trackingNumber or opportunityGroupID is not provided, the Client is subscribed globally.

header Parameters
Authorization
required
string

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey
required
string

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body schema: application/json
trackingNumber
string

A unique tracking number assigned to a specific request.

opportunityGroupID
string
url
required
string

The callback URL to which you wish to receive notifications.

failureEmailAddress
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "subscriptionId": 14
}

Unsubscribes from receiving the real time notifications whenever the esign status for signors changes.

path Parameters
subscriptionId
required
string

You can subscribe to updates for a specified URL. This unique identifier tracks the URL for you have subscribed so that you can be notified when updates are available.

header Parameters
Authorization
required
string

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

AppKey
required
string

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "userMessage": "string",
  • "trackingId": "string",
  • "transient": true,
  • "documentationalUrl": "string",
  • "remediationInfo": "string",
  • "errors": [
    ],
  • "debugInfo": [
    ]
}