Documentation Powered by Redocly

SigningHub API Guide

Download OpenAPI specification:Download

Welcome

Welcome to SigningHub, a high trust digital signing solution for all your paperless business transactions. It is ideal for those organisations that recognise the value of using cryptographic digital signatures to protect their users and their documents against unauthorised or accidental or fraudulent changes.


Browse through the API content by selecting the relevant pages from the left panel. To quickly find specific web service information, enter search criteria in the search box on top left. .
More about SigningHub
To know more about SigningHub, explore the following links:
  • Go to  SigningHub Knowledge Base to view all the relevant information of SigningHub.
  • Visit the Ascertia Community Portal to find answers to contact SigningHub support staff through the  Live Chat provision .  Our support staff may be occupied with other priority tasks so live chat is offered on an "as available" basis. 
Intended Readership
This guide is intended for developers who will integrate SigningHub into their respective web applications using the RESTful web services, and user interface offered by SigningHub. It is assumed that the reader has a basic knowledge of REST, Java, C#, HTML, JavaScript, HTTP and TLS/SSL. There is no Software Developers Kit (SDK) for the integration, instead the integration uses HTML Forms and JSON so that integration is simple from any language including .Net, Java, PHP etc.

Main Tags
Most Popular Pages
➤ Welcome
➤ Prerequisites
➤ Access Tokens
➤ Quick Integration
➤ Updates
➤ SignalR
➤ APIs Developer Guide
➤ Appendix
➤ Authentication
➤ Account Management
➤ Add Package
➤ Upload Document
➤ Get Workflow Details
➤ Sign Document

Document Preparation

This section entails the web services for the Document Preparation i.e. Add/Update/Delete Fields.

Form Fields

APIs for creating, updating, retrieving, replicating, and deleting document fields used during document processing.

Add Attachment Field

Business applications can use this service API to add an attachment field to a document in a package.

At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
order
required
integer <int32>

The order of the user in workflow for which the field is being added.

page_no
required
integer <int32>

Page number on which the field is to be created.

field_name
string or null <= 255 characters

Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.

validation_rule
required
string (Models.ValidationRule)
Enum: "OPTIONAL" "MANDATORY"
note
string or null

Attachment note in case of Mandatory attachment

required
object (Models.AddCommonFieldDimension)

AddCommonFieldDimension

Responses

Request samples

Content type
{
  • "order": 0,
  • "page_no": 0,
  • "field_name": "string",
  • "validation_rule": "OPTIONAL",
  • "note": "string",
  • "dimensions": {
    }
}

Response samples

Content type
application/json
{
  • "field_name": "string",
  • "field_locale": "string",
  • "font": {
    }
}

Update Attachment Field

Business applications can use this service API to update an attachment field of a document in a package.

Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.

You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
field_name
required
string [ 1 .. 255 ] characters

Current name of the field, that is to be updated.

renamed_as
string or null <= 255 characters

Updated name of the field if renaming is intended.

page_no
required
integer <int32>

Page number on which the field is to be created.

validation_rule
required
string (Models.ValidationRule)
Enum: "OPTIONAL" "MANDATORY"
note
string or null <= 500 characters

Attachment note in case of Mandatory attachment

required
object (Models.AttachmentFieldUpdateDimension)

AttachmentFieldUpdateDimension

Responses

Request samples

Content type
{
  • "field_name": "string",
  • "renamed_as": "string",
  • "page_no": 0,
  • "validation_rule": "OPTIONAL",
  • "note": "string",
  • "dimensions": {
    }
}

Response samples

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

Add CheckBox Field

Business applications can use this service API to add a checkbox to a document in a package.

At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

If width and height parameters are not provided, a default size of 10x10 will be assigned. If either width or height (or both) is provided, the system will compare these provided values with each other. The larger value between width and height will be assigned to both dimensions.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
order
integer <int32>

The order of the user in workflow for which the field is being added.

page_no
integer <int32>

Page number on which the field is to be created.

field_name
string or null

Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.

value
string or null

Value of the field. Possible values are "true" or "false"

required
object (Models.FieldDimension)

FieldDimension

validation_rule
string or null

One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".

Responses

Request samples

Content type
{
  • "order": 0,
  • "page_no": 0,
  • "field_name": "string",
  • "value": "string",
  • "dimensions": {
    },
  • "validation_rule": "string"
}

Response samples

Content type
application/json
{
  • "field_name": "string",
  • "field_locale": "string",
  • "font": {
    }
}

Update CheckBox Field

Business applications can use this service API to update a checkbox field of a document in a package.

Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

It's width and height cannot be updated. They will remain the same as when they were added.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
x-folder-id
string
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-folder-id
string
Default: 0

Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Request Body schema:
field_name
required
string non-empty

Current name of the field, that is to be updated.

renamed_as
string or null

Updated name of the field if renaming is intended.

page_no
integer <int32>

Page number on which the field is to be created.

value
string or null

Value of the field.

required
object (Models.FieldDimension)

FieldDimension

validation_rule
string or null

One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".

Responses

Request samples

Content type
{
  • "field_name": "string",
  • "renamed_as": "string",
  • "page_no": 0,
  • "value": "string",
  • "dimensions": {
    },
  • "validation_rule": "string"
}

Response samples

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

Update DropDown Field

Business applications can use this service API to update a dropdown field of a document in a package.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
field_name
required
string non-empty

Current name of the field, that is to be updated.

validation_rule
string (Models.ValidationRule)
Enum: "OPTIONAL" "MANDATORY"

Responses

Request samples

Content type
{
  • "field_name": "string",
  • "validation_rule": "OPTIONAL"
}

Response samples

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

Update Unique Identifier

Business applications can use this service API to update a unique identifier field of a document in a package.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
field_name
string or null <= 255 characters

Name of the field that is to be updated.

page_no
required
integer <int32>

Page number on which the field is to be created.

required
object (Models.UpdateUniqueIdentifierDimension)

UpdateUniqueIdentifierDimension

Responses

Request samples

Content type
{
  • "field_name": "string",
  • "page_no": 0,
  • "dimensions": {
    }
}

Response samples

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

Add RadioBox Field

Business applications can use this service API to add a checkbox to a document in a package.

At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

If width and height parameters are not provided, a default size of 10x10 will be assigned. If either width or height (or both) is provided, the system will compare these provided values with each other. The larger value between width and height will be assigned to both dimensions.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
order
integer <int32>

The order of the user in workflow for which the field is being added.

page_no
integer <int32>

Page number on which the field is to be created.

field_name
string or null <= 255 characters

Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.

value
string or null

Value of the field. Possible values are "true" or "false"

validation_rule
string (Models.ValidationRule)
Enum: "OPTIONAL" "MANDATORY"
radio_group_name
required
string non-empty
required
object (Models.FieldDimension)

FieldDimension

Responses

Request samples

Content type
{
  • "order": 0,
  • "page_no": 0,
  • "field_name": "string",
  • "value": "string",
  • "validation_rule": "OPTIONAL",
  • "radio_group_name": "string",
  • "dimensions": {
    }
}

Response samples

Content type
application/json
{
  • "field_name": "string",
  • "field_locale": "string",
  • "font": {
    }
}

Update RadioBox Field

Business applications can use this service API to update a radio button of a document in a package.

Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

It's width and height cannot be updated. They will remain the same as when they were added.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
field_name
required
string [ 1 .. 255 ] characters

Current name of the field, that is to be updated.

renamed_as
string or null

Updated name of the field if renaming is intended.

page_no
integer <int32>

Page number on which the field is to be created.

value
string or null

Value of the field.

validation_rule
string (Models.ValidationRule)
Enum: "OPTIONAL" "MANDATORY"
radio_group_name
required
string non-empty

The group name to which the field belongs.

required
object (Models.FieldDimension)

FieldDimension

Responses

Request samples

Content type
{
  • "field_name": "string",
  • "renamed_as": "string",
  • "page_no": 0,
  • "value": "string",
  • "validation_rule": "OPTIONAL",
  • "radio_group_name": "string",
  • "dimensions": {
    }
}

Response samples

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

Add TextBox Field

Business applications can use this service API to add a text input field to a document in a package.

At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
order
integer <int32>

The order of the user in workflow for which the field is being added.

page_no
integer <int32>

Page number on which the field is to be created.

type
string (Models.TextboxType)
Enum: "TEXT" "NAME" "EMAIL" "COMPANY" "JOBTITLE" "DATE"
value
string or null

Value of the field. For type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned.

placeholder
string or null

Placeholder text for the text field. For name, email, company, job title and date, placeholder value can be "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". Developers can send their own placeholders to overwrite the default values. For "TEXT" developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer.

max_length
integer <int32>

Maximum length of the value allowed in the field. Must between 1 - 9999

format
string or null

Text format of the field. Used for the date type field only. Possible values are

  • m/d
  • m/d/yy
  • m/d/yyyy
  • mm/dd/yy
  • mm/dd/yyyy
  • mm/yy
  • mm/yyyy
  • d-mmm
  • d-mmm-yy
  • d-mmm-yyyy
  • dd-mmm-yy
  • dd-mmm-yyyy
  • yy-mm-dd
  • yyyy-mm-dd
  • mmm-yy
  • mmm-yyyy
  • mmmm-yy
  • mmmm-yyyy
  • mmmm d, yyyy
  • dd/mm/yy
  • ddmmmyyyy
field_name
string or null

Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.

field_locale
string or null

Field local. Possible values are ar-AE | en-US. Optional and default will be en-US. This value matters for type "DATE" and "NUMBER"

field_type
required
string (Models.FieldType)
Enum: "Number" "Text"
validation_rule
string (Models.ValidationRule)
Enum: "OPTIONAL" "MANDATORY"
object (Models.FieldValidationValue)
required
object (Models.Font)

Font

required
object (Models.FieldDimension)

FieldDimension

multiline
boolean

If set to true, text area field would be created

Responses

Request samples

Content type
{
  • "order": 0,
  • "page_no": 0,
  • "type": "TEXT",
  • "value": "string",
  • "placeholder": "string",
  • "max_length": 0,
  • "format": "string",
  • "field_name": "string",
  • "field_locale": "string",
  • "field_type": "Number",
  • "validation_rule": "OPTIONAL",
  • "validation": {
    },
  • "font": {
    },
  • "dimensions": {
    },
  • "multiline": true
}

Response samples

Content type
application/json
{
  • "field_name": "string",
  • "field_locale": "string",
  • "font": {
    }
}

Update TextBox Field

Business applications can use this service API to update a text box of a document in a package.

Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged. You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields. The latter can be used when a template was applied or the document was created using the GUI interface.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
field_name
required
string non-empty

Current name of the field, that is to be updated.

field_locale
string or null

Field local. Possible values are ar-AE | en-US. Optional and default will be en-US. This value matters for type "DATE" and "NUMBER"

renamed_as
string or null

Updated name of the field if renaming is intended.

page_no
integer <int32>

Page number on which the field is to be created.

value
string or null

Value of the field. For type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned.

max_length
integer <int32>

Maximum length of the value allowed in the field. Must between 1 - 9999

field_type
string (Models.FieldType)
Enum: "Number" "Text"
validation_rule
string (Models.ValidationRule)
Enum: "OPTIONAL" "MANDATORY"
object (Models.Font)

Font

object (Models.FieldDimension)

FieldDimension

placeholder
string or null

Developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer.

format
string or null

Text format of the field. Used for the date type field only. Possible values are

  • m/d
  • m/d/yy
  • m/d/yyyy
  • mm/dd/yy
  • mm/dd/yyyy
  • mm/yy
  • mm/yyyy
  • d-mmm
  • d-mmm-yy
  • d-mmm-yyyy
  • dd-mmm-yy
  • dd-mmm-yyyy
  • yy-mm-dd
  • yyyy-mm-dd
  • mmm-yy
  • mmm-yyyy
  • mmmm-yy
  • mmmm-yyyy
  • mmmm d, yyyy
  • dd/mm/yy
  • ddmmmyyyy
object (Models.FieldValidationValue)

Responses

Request samples

Content type
{
  • "field_name": "string",
  • "field_locale": "string",
  • "renamed_as": "string",
  • "page_no": 0,
  • "value": "string",
  • "max_length": 0,
  • "field_type": "Number",
  • "validation_rule": "OPTIONAL",
  • "font": {
    },
  • "dimensions": {
    },
  • "placeholder": "string",
  • "format": "string",
  • "validation": {
    }
}

Response samples

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

Signature Fields

APIs for managing signature-related fields including signatures, initials, stamps, and in-person signing fields.

Add Initial Field

Business applications can use this service API to add an initials field to a document in a package.

At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
order
integer <int32>

The order of the user in workflow for which the field is being added.

page_no
integer <int32>

Page number on which the field is to be created.

field_name
string or null

Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.

required
object (Models.FieldDimension)

FieldDimension

Responses

Request samples

Content type
{
  • "order": 0,
  • "page_no": 0,
  • "field_name": "string",
  • "dimensions": {
    }
}

Response samples

Content type
application/json
{
  • "field_name": "string",
  • "field_locale": "string",
  • "font": {
    }
}

Update Initial Field

Business applications can use this service API to update an initials field of a document in a package.

Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.

You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
field_name
required
string non-empty

Current name of the field, that is to be updated.

renamed_as
string or null

Updated name of the field if renaming is intended.

page_no
integer <int32>

Page number on which the field is to be created.

required
object (Models.FieldDimension)

FieldDimension

Responses

Request samples

Content type
{
  • "field_name": "string",
  • "renamed_as": "string",
  • "page_no": 0,
  • "dimensions": {
    }
}

Response samples

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

Replicate Initial Fields

Business applications can use this service API to replicate initial fields to the multiple pages of a document in a package.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

field_name
required
string

Specifies the name of the field to be replicated across multiple pages. Suggested to pass in base64 string format.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:

List of page numbers

pages
required
Array of integers <int32> [ items <int32 > ]

List of page number for which field need to replicate

Responses

Request samples

Content type
{
  • "pages": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Add In-person Field

Business applications can use this service API to an add in-person signature field to a document in a package.

At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

In order to host an in-person meeting a SigningHub user must be part of the workflow.They must either be added with Role "INPERSON_HOST" or "SIGNER". For the host option they do not require a signature or input field on the document, and the in-person signature field can be signed by the non-SigningHub registered user.

Note this is a special workflow scenario whereby it is expected that the SigningHub user and recipient would be in the same location.This type of signature is not intended for use whereby a document is shared with recipients over email link in the normal loose integration method.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
order
integer <int32>

The order of the user in workflow for which the field is being added.

page_no
integer <int32>

Page number on which the field is to be created.

field_name
string or null

Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.

placeholder
required
string non-empty

String identifier for the inperson field, it can be Customer, Jack, CEO etc.

required
object (Models.FieldDimension)

FieldDimension

display
string or null

Visibility of the field that is to be added, possible values are "VISIBLE" and "INVISIBLE"

level_of_assurance
Array of strings or null

Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"

object (Models.SignatureFieldAuthentication)

SignatureFieldAuthentication

Responses

Request samples

Content type
{
  • "order": 0,
  • "page_no": 0,
  • "field_name": "string",
  • "placeholder": "string",
  • "dimensions": {
    },
  • "display": "string",
  • "level_of_assurance": [
    ],
  • "authentication_signing": {
    }
}

Response samples

Content type
application/json
{
  • "field_name": "string",
  • "field_locale": "string",
  • "font": {
    }
}

Update In-person Field

Business applications can use this service API to update an in-person signature field of a document in a package.

Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
x-folder-id
string
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-folder-id
string
Default: 0

Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Request Body schema:
field_name
required
string non-empty

Current name of the field, that is to be updated.

renamed_as
string or null

updated name of the field, if renaming is intended.

page_no
integer <int32>

Page number on which the field is to be created.

placeholder
string or null

String identifier for the in-person field, it can be Customer, Jack, CEO etc.

object (Models.FieldDimension)

FieldDimension

display
string or null

Visibility of the field that is to be updated, possible values are "VISIBLE" and "INVISIBLE"

level_of_assurance
Array of strings or null

Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"

object (Models.SignatureFieldAuthentication)

SignatureFieldAuthentication

Responses

Request samples

Content type
{
  • "field_name": "string",
  • "renamed_as": "string",
  • "page_no": 0,
  • "placeholder": "string",
  • "dimensions": {
    },
  • "display": "string",
  • "level_of_assurance": [
    ],
  • "authentication_signing": {
    }
}

Response samples

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

Replicate In-person Fields

Business applications can use this service API to replicate In-person fields to the multiple pages of a document in a package.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

field_name
required
string

Specifies the name of the field to be replicated across multiple pages. Suggested to pass in base64 string format.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:

List of page numbers

pages
required
Array of integers <int32> [ items <int32 > ]

List of page number for which field need to replicate

Responses

Request samples

Content type
{
  • "pages": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Add Digital Signature Field

Business applications can use this service API to add a digital signature field to a document in a package.

At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow.

See Add Users to Workflow for more information.Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

path Parameters
packageId
required
integer <int64>

The package ID for which workflow details need to be updated.

documentId
required
integer <int64>

The document ID where the field is to be added.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
order
integer <int32>

Order of the recipient for which the field is being created.

page_no
integer <int32>

Page number at which the field is about to be created.

field_name
string or null

Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.

level_of_assurance
Array of strings or null

Level Of Assurance to be added. Possible Values are "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

object (Models.FieldDimension)

FieldDimension

display
string or null

Visibility of the field that is to be added, possible values are "VISIBLE" and "INVISIBLE"

object (Models.SignatureFieldAuthentication)

SignatureFieldAuthentication

Responses

Request samples

Content type
{
  • "order": 0,
  • "page_no": 0,
  • "field_name": "string",
  • "level_of_assurance": [
    ],
  • "dimensions": {
    },
  • "display": "string",
  • "authentication_signing": {
    }
}

Response samples

Content type
application/json
{
  • "field_name": "string",
  • "created_on": "string"
}

Update Digital Signature Field

Business applications can use this service API to update a digital signature field of a document in a package.

Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
x-folder-id
string
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-folder-id
string
Default: 0

Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Request Body schema:
field_name
required
string non-empty

Current name of the field, which is to be updated.

level_of_assurance
Array of strings or null

Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

renamed_as
string or null

Updated name of the field if renaming of the field is intended.

page_no
integer <int32>

Page number on which the field is to be created.

object (Models.FieldDimension)

FieldDimension

display
string or null

Visibility of the field that is to be updated, possible values are "VISIBLE" and "INVISIBLE"

object (Models.SignatureFieldAuthentication)

SignatureFieldAuthentication

Responses

Request samples

Content type
{
  • "field_name": "string",
  • "level_of_assurance": [
    ],
  • "renamed_as": "string",
  • "page_no": 0,
  • "dimensions": {
    },
  • "display": "string",
  • "authentication_signing": {
    }
}

Response samples

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

Add Stamp Field

Business applications can use this service API to add an stamp field to a document in a package.

At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
order
integer <int32>

The order of the user in workflow for which the field is being added.

page_no
integer <int32>

Page number on which the field is to be created.

field_name
string or null

Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.

validation_rule
string (Models.StampValidationRule)
Enum: "MANDATORY" "OPTIONAL"
required
object (Models.FieldDimension)

FieldDimension

Responses

Request samples

Content type
{
  • "order": 0,
  • "page_no": 0,
  • "field_name": "string",
  • "validation_rule": "MANDATORY",
  • "dimensions": {
    }
}

Response samples

Content type
application/json
{
  • "field_name": "string",
  • "validation_rule": "MANDATORY"
}

Update Stamp Field

Business applications can use this service API to update an stamps field of a document in a package.

Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.

You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
field_name
required
string non-empty

Current name of the field, that is to be updated.

renamed_as
string or null

Updated name of the field if renaming is intended.

page_no
integer <int32>

Page number on which the field is to be created.

required
object (Models.FieldDimension)

FieldDimension

validation_rule
required
string (Models.StampValidationRule)
Enum: "MANDATORY" "OPTIONAL"

Responses

Request samples

Content type
{
  • "field_name": "string",
  • "renamed_as": "string",
  • "page_no": 0,
  • "dimensions": {
    },
  • "validation_rule": "MANDATORY"
}

Response samples

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

Replicate Stamp Fields

Business applications can use this service API to replicate stamp fields to the multiple pages of a document in a package.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

field_name
required
string

Specifies the name of the field to be replicated across multiple pages. Suggested to pass in base64 string format.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:

List of page numbers

pages
required
Array of integers <int32> [ items <int32 > ]

List of page number for which field need to replicate

Responses

Request samples

Content type
{
  • "pages": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Comment Field

APIs for managing document comments, comment fields, replies, and comment notifications.

Add Comment Field

Business applications can use this service API to add an comment field to a document in a package.

At least one user must exist in a workflow other then current recipient.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
page_no
required
integer <int32>

Page number on which the field is to be created.

comment
required
string [ 1 .. 500 ] characters

Comment text.

required
object (Models.AddCommonFieldDimension)

AddCommonFieldDimension

Array of objects or null (Models.AddCommentFieldRecipient)

Recipients

Responses

Request samples

Content type
{
  • "page_no": 0,
  • "comment": "string",
  • "dimensions": {
    },
  • "recipients": [
    ]
}

Response samples

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

Update Comment Field

Business applications can use this service API to update an comment in a package.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

commentId
required
integer <int64>

The comment ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
comment
required
string [ 1 .. 500 ] characters

Comment text.

Responses

Request samples

Content type
{
  • "comment": "string"
}

Response samples

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

Delete Comment Field

Business applications can use this service API to delete a comment field to a document in a package.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

commentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

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

Get Field Comments

Business applications can use this service API to get field comment.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

commentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Reply to a Comment

Business applications can use this service API to reply to a comment of a document in a package.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

commentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
comment
required
string [ 1 .. 500 ] characters

Comment text.

Responses

Request samples

Content type
{
  • "comment": "string"
}

Response samples

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

Mark Comments as read

Business applications can use this service API to mark comments as read.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

commentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

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

Get Comment Fields

Business applications can use this service API to get comment fields.

path Parameters
packageId
required
integer <int64>

The ID of the package to which the document is added.

documentId
required
integer <int64>
Default: 0

The ID of the document for which the fields are requested. If document id is not provided fields of whole package are returned.

pageNo
required
integer <int32>
Default: 0

Page no of the document for which the fields are requested. If page number is not provided fields of whole document are returned.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-mobile
string
Default: TRUE

Define the originator(Web/Mobile) of the request/action

Responses

Response samples

Content type
application/json
[
  • {
    }
]

QR Code

APIs for creating, updating, and previewing QR codes within documents.

Add QR Code

Business applications can use this service API to add a QR Code to a document in a package.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
page_no
integer <int32>

Page number on which the field is to be created.

field_name
string or null <= 255 characters

Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.

required
object (Models.FieldDimension)

FieldDimension

data
string or null <= 500 characters

The plain text data to be encoded in the QR code. Default is URL generated to access the related document. e.g. {base_url}/document/{document_unique_id}

object (Models.QrCodeOptions)

QrCodeOptions

object (Models.QrCodeColor)

QrCodeColor

object (Models.QrCodeLogo)

QrCodeLogo

Responses

Request samples

Content type
{
  • "page_no": 0,
  • "field_name": "string",
  • "dimensions": {
    },
  • "data": "string",
  • "options": {
    },
  • "color": {
    },
  • "logo": {
    }
}

Response samples

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

Update QR Code

Business applications can use this service API to update a QR Code of a document in a package.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
field_name
required
string [ 1 .. 255 ] characters

Current name of the field, that is to be updated.

renamed_as
string or null

Updated name of the field if renaming is intended.

page_no
integer <int32>

Page number for which field is need to be updated

required
object (Models.FieldDimension)

FieldDimension

data
string or null <= 500 characters

The plain text data to be encoded in the QR code. Default is URL generated to access the related document. e.g. {base_url}/document/{document_unique_id}

object (Models.QrCodeOptions)

QrCodeOptions

object (Models.QrCodeColor)

QrCodeColor

object (Models.QrCodeLogo)

QrCodeLogo

Responses

Request samples

Content type
{
  • "field_name": "string",
  • "renamed_as": "string",
  • "page_no": 0,
  • "dimensions": {
    },
  • "data": "string",
  • "options": {
    },
  • "color": {
    },
  • "logo": {
    }
}

Response samples

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

Preview QR Code

Business applications can use this service API to preview a QR Code.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
data
required
string [ 1 .. 500 ] characters

The plain text data to be encoded in the QR code.

object (Models.QrCodeOptions)

QrCodeOptions

object (Models.QrCodeColor)

QrCodeColor

object (Models.QrCodeLogo)

QrCodeLogo

Responses

Request samples

Content type
{
  • "data": "string",
  • "options": {
    },
  • "color": {
    },
  • "logo": {
    }
}

Response samples

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

Field Operations

APIs for assigning document fields to recipients and automating field placement.

Assign Document Field

Business applications can use this service API to assign users to input fields, e.g. signature fields, and hence define the signing order. The fields must already be present in the document and the users must be present in the workflow. The ID of the workflow document is provided in the resource URL, along with the package identifier.

When recipients are in a workflow they are numbered, beginning at one and counting up for each extra one.Therefore, if there are three users in a workflow they are numbered "1", "2", and "3" respectfully.This API call allows you to assign a user by their workflow order number, to an input field on the document.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which workflow user needs to be updated.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
Array
field_name
required
string non-empty

Name of the signature field that is to be assigned.

radio_group_name
string or null

provide group name for radio box

order
integer <int32>

The order of the user in workflow, to which the field is being assigned.

level_of_assurance
Array of strings or null

Level Of Assurance to be added. Possible Values are "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

AutoPlace Fields

Business applications can call this API to add signature or user defined form fields to a document based upon the search criterion supplied. The placement options are: to the left, to the right, top and bottom. The document is search and all instances of the search criteria met are processed. This allows you to add multiple fields with one call. For example, upload a document and automatically place a signature field to the right of all instances of the word "Sign here:". This saves time and ensures no signatures are missed from the workflow.

The API call supports all types of fields; namely electronic, digital, in-person, initials, and text field etc.

In addition, the API call supports the "order" variable.This means you can assign a set of signature fields automatically to a single user.Hence, the call can be repeated to place and assign signature fields to more than one user in the workflow.

At least one user must exist in a workflow before signature fields can be added to the document in this way.The order number corresponds to the recipient in the workflow. Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow.

This API call can be used multiple times on the same document.The reason for doing so is to cater for multiple signatories on a document.The recipient or signatory is identified by the "order" variable passed in the call.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

path Parameters
packageId
required
integer <int64>

The ID of the package to which the document is added.

documentId
required
integer <int64>

The ID of the document for which the fields are requested.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
search_text
string or null

Word that needs to be searched in the document.

order
integer <int32>

Order of the user to which the fields will be assigned automatically. Workflow in SigningHub orders recipients. This list begins with “1” for the first designated signer.

placement
string or null

If the text is found, fields are to be placed in the document. Placement of the field can be mentioned in this attribute. Possible values of placement of a field are LEFT, RIGHT, TOP, BOTTOM. If no value is provided the default value will be LEFT.

field_type
string or null

Type of field to be created in the document. Possible values are "SIGNATURE", "IN_PERSON_SIGNATURE", "INITIALS", "STAMP", "TEXT", "NUMBER" ,"NAME", "EMAIL", "COMPANY", "JOBTITLE", "RADIOBOX", "CHECKBOX", "DATE", "ATTACHMENT"

level_of_assurance
Array of strings or null

Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE". Will only be provided in case of In-person and Signature.

object (Models.FieldDimension)

FieldDimension

placeholder
string or null

Provide note in the case of Mandatory Attachment

radio_group_name
string or null

The group name required only when adding a Radio Box type field to group multiple Radio boxes together.

format
string or null

Text format of the field. Used for the date type field only. Possible values are

  • m/d
  • m/d/yy
  • m/d/yyyy
  • mm/dd/yy
  • mm/dd/yyyy
  • mm/yy
  • mm/yyyy
  • d-mmm
  • d-mmm-yy
  • d-mmm-yyyy
  • dd-mmm-yy
  • dd-mmm-yyyy
  • yy-mm-dd
  • yyyy-mm-dd
  • mmm-yy
  • mmm-yyyy
  • mmmm-yy
  • mmmm-yyyy
  • mmmm d, yyyy
  • dd/mm/yy
  • ddmmmyyyy
value
string or null

Value that user want to show in the field.

field_locale
string or null

Field local. Possible values are ar-AE | en-US. Optional and default will be en-US. This value matters for type "DATE" and "NUMBER"

max_length
integer <int32>

Maximum length of the value allowed in the field. Must between 1 - 9999

validation_rule
string or null

One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".

object (Models.FieldValidationValue)
object (Models.Font)

Font

multiline
boolean

This belongs to Text Area field type and If set to true, text area field would be created with multi line option.

Responses

Request samples

Content type
{
  • "search_text": "string",
  • "order": 0,
  • "placement": "string",
  • "field_type": "string",
  • "level_of_assurance": [
    ],
  • "dimensions": {
    },
  • "placeholder": "string",
  • "radio_group_name": "string",
  • "format": "string",
  • "value": "string",
  • "field_locale": "string",
  • "max_length": 0,
  • "validation_rule": "string",
  • "validation": {
    },
  • "font": {
    },
  • "multiline": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete Document Field

Business applications can use this service API to delete a field of document in a package.

path Parameters
packageId
required
integer <int64>

Package ID to which the document is added.

documentId
required
integer <int64>

The document ID for which the action is to be taken.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
field_name
required
string non-empty

Name of the field to be deleted.

Responses

Request samples

Content type
{
  • "field_name": "string"
}

Response samples

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

Get Document Fields

Business applications can use this service API to get document fields i.e., initials, stamps, in-persons, signature fields or form fields.

path Parameters
packageId
required
integer <int64>

The ID of the package to which the document is added.

documentId
required
integer <int64>

The ID of the document for which the fields are requested.

pageNo
required
integer <int32>
Default: 0

Page no of the document for which the fields are requested. If page number is not provided fields of whole document are returned.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-mobile
string
Default: TRUE

Define the originator(Web/Mobile) of the request/action

Responses

Response samples

Content type
application/json
{
  • "signature": [
    ],
  • "hand_signature": [
    ],
  • "electronic_signature": [
    ],
  • "initials": [
    ],
  • "stamps": [
    ],
  • "in_person_signature": [
    ],
  • "text": [
    ],
  • "radio": [
    ],
  • "checkbox": [
    ],
  • "dropdown": [
    ],
  • "listbox": [
    ],
  • "qrcode": [
    ],
  • "attachment": [
    ],
  • "comment": [
    ],
  • "unique_identifier": [
    ]
}

Bulk Delete Document Field

path Parameters
packageId
required
integer <int64>

Document package id.

documentId
required
integer <int64>

Document id.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:

Request object containing field names.

field_names
Array of strings or null

Array of field names to be deleted.

Responses

Request samples

Content type
{
  • "field_names": [
    ]
}

Response samples

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