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

Template

APIs for creating, managing, importing, exporting, and configuring reusable document workflow templates.

Template Management

APIs for creating, updating, cloning, importing, exporting, deleting, and maintaining personal and enterprise templates.

Get Enterprise Templates

Business applications can use this service API to get list of enterprise templates of the current user. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.

It is possible to search based upon the criterion supplied under the "x-search-text" header.

path Parameters

recordPerPage required	integer <int32> Total number of records to be retrieved in a page.
pageNo required	integer <int32> Page number to be retrieved.

query Parameters

sort-by	string (Enumerations.TemplateSortBy) Enum: "CREATED_ON" "NAME" "DESCRIPTION" "READ_ONLY" "IS_PUBLIC" Sort the result by possible values are mentioned above.
asc	boolean Default: false Order the result set by ascending or descending.
id	Array of integers <int64> [ items <int64 > ] Search by template ids.

header Parameters

X-Search-Text	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-search-text	string Default: TXkgdGVtcGxhdGU= Search text if required. This is optional and without it the entire list is returned. Furthermore, recommended value for search text parameter is in Base64 encoded format.
x-total-records	string Default: 10 The total number of records found with the provided search criteria.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": 0,
"name": "string",
"public": true,
"read_only": true,
"description": "string",
"created_on": "string",
"roles": [{"name": "string",
"id": 0
}
],
"documents": [{"id": 0,
"name": "string"
}
]
}
]

Export Enterprise Template

Business applications can use this service API to export the enterprise templates. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".

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:
application/json

List of ids of enterprise templates

Array

integer <int32>

Responses

Request samples

Payload

Content type

application/json

[0
]

Response samples

200
401
403
500

Content type

application/json

"string"

Import Enterprise Template

Business applications can use this service API to import the enterprise templates. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".

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.
Accept required	string Default: application/json
Content-Type required	string Default: multipart/form-data

Request Body schema: multipart/form-data

Schema not provided

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"success": [{"id": 0,
"name": "string",
"public": true,
"read_only": true,
"description": "string",
"created_on": "string"
}
],
"failure": [{"name": "string",
"error_message": "string"
}
]
}
]

Download Import Enterprise Template (Template)

Business applications can use this service API to retrieve an import template for enterprise template.

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

Responses

Response samples

200
401
403
500

Content type

application/json

"string"

Add Enterprise Template

Business applications can use this service API to add enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".

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.
Accept required	string Default: application/json
Content-Type required	string Default: multipart/form-data

Request Body schema: multipart/form-data

file required	string <binary>
name required	string
description	string
read_only	boolean
public	boolean

Responses

Response samples

Content type

application/json

{"id": 0,
"created_on": "string",
"documents": [{"id": 0,
"name": "string",
"certify": {"enabled": true,
"allowed_permissions": ["string"
],
"default_permission": "string"
},
"lock_form_fields": true
}
],
"workflow": {"workflow_type": "string",
"continue_on_decline": true,
"post_process": {"enabled": true,
"contacts": ["string"
],
"recipients": [{"name": "string",
"email": "string"
}
],
"message": "string",
"google_drive": true,
"one_drive": true,
"dropbox": true,
"workflow_recipients": true,
"document_processing_report": true
},
"comments": true
}
}

Bulk Delete Enterprise Template

Business applications can use this service API to bulk delete the enterprise templates. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".

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:
application/json

List of ids of enterprise templates.

Array

integer <int32>

Responses

Request samples

Payload

Content type

application/json

[0
]

Response samples

200
400
401
403
500

Content type

application/json

[{"id": 0,
"error_message": "string"
}
]

Add Personal Template to Enterprise

Business applications can use this service API to save personal template as enterprise template.

path Parameters

id

required

integer <int32>

The ID of personal template.

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:
application/json

name required	string [ 1 .. 255 ] characters Name of the template to be saved.
description	string or null <= 255 characters Description of the template to be saved.
read_only	boolean Is template to be saved readonly.
public	boolean Is template to be saved public.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"read_only": true,
"public": true
}

Response samples

200
401
403
404
500

Content type

application/json

{"id": 0
}

Add Personal Template

Business applications can use this service API to add personal template.

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.
Accept required	string Default: application/json
Content-Type required	string Default: multipart/form-data

Request Body schema: multipart/form-data

file required	string <binary>
name required	string
description	string
read_only	boolean

Responses

Response samples

Content type

application/json

{"id": 0,
"created_on": "string",
"documents": [{"id": 0,
"name": "string",
"certify": {"enabled": true,
"allowed_permissions": ["string"
],
"default_permission": "string"
},
"lock_form_fields": true
}
],
"workflow": {"workflow_type": "string",
"continue_on_decline": true,
"post_process": {"enabled": true,
"contacts": ["string"
],
"recipients": [{"name": "string",
"email": "string"
}
],
"message": "string",
"google_drive": true,
"one_drive": true,
"dropbox": true,
"workflow_recipients": true,
"document_processing_report": true
},
"comments": true
}
}

Bulk Delete Personal Template

Business applications can use this service API to bulk delete the user templates.

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:
application/json

List of ids of user templates.

Array

integer <int32>

Responses

Request samples

Payload

Content type

application/json

[0
]

Response samples

200
401
403
500

Content type

application/json

[{"id": 0,
"error_message": "string"
}
]

Get Template by ID

Business applications can use this service API to get a personal/enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".

path Parameters

id

required

integer <int32>

The ID of personal/enterprise template.

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

200
401
403
404
500

Content type

application/json

{"name": "string",
"public": true,
"read_only": true,
"description": "string",
"created_on": "string",
"enterprise": true,
"documents": [{"id": 0,
"name": "string"
}
]
}

Delete Template

Business applications can use this service API to delete personal/enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".

path Parameters

id

required

integer <int32>

The ID of personal/enterprise template.

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

400
401
403
404
500

Content type

application/json

{"Message": "string"
}

Update Template

Business applications can use this service API to update personal/enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".

path Parameters

id

required

integer <int32>

The ID of personal/enterprise template.

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:
application/json

name required	string [ 1 .. 255 ] characters Name.
description	string or null <= 255 characters Description.
read_only	boolean True, if the template is marked as read-only.
public	boolean True, if the template is marked as public.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"read_only": true,
"public": true
}

Response samples

Content type

application/json

{"Message": "string"
}

Save Template

Business applications can use this service API to save serialize all the changes made in redis and save it in the database of the personal/enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".

path Parameters

id

required

integer <int32>

The ID of personal/enterprise template.

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:
application/json

Array of objects or null (Models.FormFieldRequest)

Responses

Request samples

Payload

Content type

application/json

{"form_fields": [{"field_name": "string",
"field_value": "string"
}
]
}

Response samples

401
403
404
500

Content type

application/json

{"Message": "string"
}

Save Workflow as Template

Business applications can use this service API to save workflow as template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".

path Parameters

packageId

required

integer <int64>

The package ID for which the save workflow as template.

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:
application/json

name required	string [ 1 .. 255 ] characters Name of the template that is to be added.
description	string or null <= 255 characters Name of the description that is to be added.
scopes	Array of strings or null (Enumerations.TemplateScope) Enum: "PERSONAL" "ENTERPRISE" Scope of template that is to be added.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"scopes": ["PERSONAL"
]
}

Response samples

Content type

application/json

{"id": 0,
"enterprise_template_id": 0
}

Clone Template

Business applications can use this service API to clone personal/enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".

path Parameters

id

required

integer <int64>

The ID of personal/enterprise template that need to be clone.

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:
application/json

name required	string [ 1 .. 255 ] characters Name of the template that is to be added.
description	string or null <= 255 characters Description of the template that is to be added.
read_only	boolean True, if the template is marked as read-only.
public	boolean True, if the template is marked as public.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"read_only": true,
"public": true
}

Response samples

Content type

application/json

{"id": 0,
"enterprise_template_id": 0
}

Discard Changes

Business applications can use this service API to discard the changes of the personal/enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".

path Parameters

id

required

integer <int32>

The ID of personal/enterprise template.

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

401
403
404
500

Content type

application/json

{"Message": "string"
}

Get Personal/Enterprise Template Details

Business applications can use this service API to get details of the personal/enterprise template.

path Parameters

templateId

required

integer <int32>

The ID of personal/enterprise template.

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

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"template_id": 0,
"template_name": "string",
"uploaded_on": "string",
"modified_on": "string",
"workflow": {"workflow_type": "string",
"continue_on_decline": true,
"message": "string",
"post_process": {"enabled": true,
"contacts": ["string"
],
"recipients": [{"name": "string",
"email": "string"
}
],
"message": "string",
"google_drive": true,
"one_drive": true,
"dropbox": true,
"workflow_recipients": true,
"document_processing_report": true
},
"comments": true
},
"documents": [{"document_id": 0,
"document_name": "string",
"document_order": 0,
"document_height": 0,
"document_width": 0,
"document_pages": 0,
"created_on": "string",
"modified_on": "string",
"form_fields": true,
"certify": {"enabled": true,
"allowed_permissions": ["string"
],
"default_permission": "string"
},
"lock_form_fields": true
}
],
"users": [{"order": 0,
"user_name": "string",
"user_email": "string",
"user_photo_url": "string",
"group_name": "string",
"group_members": ["string"
],
"role": "string",
"placeholder": "string",
"permission": {"print": true,
"artificial_intelligence": {"enabled": true
},
"download": true,
"add_text": true,
"change_recipients": true,
"add_attachment": true,
"legal_notice": {"enabled": true,
"allowed_notices": [{"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
],
"default_notice": {"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
},
"attachment_preview": {"enabled": true
}
},
"authentications": {"authentication": {"enabled": true,
"password": {"enabled": true,
"user_password": "string"
},
"sms_otp": {"enabled": true,
"otp_length": 0,
"retry_duration": 0,
"mobile_number": "string",
"methods": ["string"
]
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"identity_verification_policy": {"id": 0,
"name": "string"
}
}
},
"authentication_signing": {"enabled": true,
"sms_otp": {"otp_length": 0,
"retry_duration": 0,
"mobile_number": "string",
"methods": ["string"
]
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"identity_verification_policy": {"id": 0,
"name": "string"
}
}
},
"access_duration": {"enabled": true,
"duration_by_date": {"enabled": true,
"accessible": true,
"duration": {"start_date_time": "string",
"end_date_time": "string"
}
},
"duration_by_days": {"enabled": true,
"accessible": true,
"duration": {"total_days": 0
}
}
}
},
"reminder": {"enabled": true,
"frequency": "string",
"remind_after": 0,
"repeat": {"enabled": true,
"frequency": "string",
"keep_reminding_after": 0,
"total_reminders": 0
}
},
"signing_order": 0,
"user_national_id": "string",
"guest_user": true,
"email_language_code": "string",
"electronic_seal": {"name": "string",
"level_of_assurance": "string"
},
"mobile_number": "string",
"delivery_method": "string",
"logged_in_user": true
}
],
"fields": {"signature": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"created_on": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"nid": "string",
"display": "string",
"level_of_assurance": ["string"
],
"authentication": {"enabled": true,
"sms_otp": {"enabled": true,
"otp_length": 0,
"retry_duration": 0,
"mobile_number": "string",
"methods": ["string"
]
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"policy": {"id": 0,
"name": "string"
}
}
},
"last_page": true
}
],
"hand_signature": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"last_page": true,
"nid": "string"
}
],
"electronic_signature": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"signature_sub_type": "string",
"authentication": {"enabled": true,
"sms_otp": {"enabled": true,
"otp_length": 0,
"retry_duration": 0,
"mobile_number": "string",
"methods": ["string"
]
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"policy": {"id": 0,
"name": "string"
}
}
},
"nid": "string",
"display": "string",
"last_page": true
}
],
"initials": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"last_page": true
}
],
"stamps": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"last_page": true,
"validation_rule": "MANDATORY"
}
],
"in_person_signature": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"placeholder": "string",
"signature_sub_type": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"display": "string",
"level_of_assurance": ["string"
],
"authentication": {"enabled": true,
"sms_otp": {"enabled": true,
"otp_length": 0,
"retry_duration": 0,
"mobile_number": "string",
"methods": ["string"
]
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"policy": {"id": 0,
"name": "string"
}
}
},
"last_page": true
}
],
"text": [{"required": true,
"order": 0,
"tab_order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"value": "string",
"read_only": true,
"validation_rule": "string",
"validation": {"required": true,
"rules": [{"type": "string",
"value": "string"
}
]
},
"visible": true,
"multiline": true,
"field_locale": "string",
"font": {"name": "string",
"size": 0,
"embedded_size": 0
},
"max_length": 0,
"format_type": "string",
"placeholder": "string",
"format": "string",
"color": "string",
"embedded": true,
"border_color": "string",
"tooltip": "string",
"field_rotation": 0,
"align": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
}
}
],
"radio": [{"required": true,
"order": 0,
"tab_order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"value": true,
"read_only": true,
"validation_rule": "string",
"radio_group_name": "string",
"checked": true,
"visible": true,
"color": "string",
"embedded": true,
"border_color": "string",
"tooltip": "string",
"field_rotation": 0,
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
}
}
],
"checkbox": [{"required": true,
"order": 0,
"tab_order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"value": true,
"read_only": true,
"checked": true,
"visible": true,
"validation_rule": "string",
"color": "string",
"embedded": true,
"border_color": "string",
"tooltip": "string",
"field_rotation": 0,
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
}
}
],
"dropdown": [{"required": true,
"order": 0,
"tab_order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"validation_rule": "string",
"read_only": true,
"value": "string",
"choices": ["string"
],
"visible": true,
"color": "string",
"embedded": true,
"border_color": "string",
"tooltip": "string",
"field_rotation": 0,
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"font": {"name": "string",
"size": 0,
"embedded_size": 0
}
}
],
"listbox": [{"order": 0,
"tab_order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"validation_rule": "string",
"read_only": true,
"value": "string",
"choices": ["string"
],
"visible": true,
"color": "string",
"embedded": true,
"border_color": "string",
"tooltip": "string",
"field_rotation": 0,
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"font": {"name": "string",
"size": 0,
"embedded_size": 0
}
}
],
"qrcode": [{"field_name": "string",
"type": "string",
"page_no": 0,
"value": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"data": "string",
"options": {"error_correction_level": "Default",
"encoding": "Default",
"pixels_per_module": 0,
"add_margins": true
},
"color": {"dots": "string",
"background": "string"
},
"logo": {"base64": "string",
"hide_background_dots": true,
"size": 0
}
}
],
"attachment": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"attachmentRefId": 0,
"note": "string",
"validation_rule": "OPTIONAL",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
}
}
]
}
}

Workflow Management

APIs for configuring workflow participants, permissions, authentication, reminders, and workflow settings within templates.

Get Workflow User Permission (Template)

Business applications can use this service API to get document permissions for a recipient. Recipient is identified by the order in the workflow.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
order required	integer <int32> The order of the user in template workflow for which the permissions 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

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"print": true,
"artificial_intelligence": {"enabled": true
},
"download": true,
"add_text": true,
"change_recipients": true,
"add_attachment": true,
"legal_notice": {"enabled": true,
"allowed_notices": [{"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
],
"default_notice": {"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
},
"attachment_preview": {"enabled": true
}
}

Update Workflow User Permission (Template)

Business applications can use this service API to update the workflow permissions for a user that has already been added to a personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template for which workflow permissions to be updated.
order required	integer <int32> The order of the recipient for which the workflow permissions 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:
application/json

apply_to_all required	boolean True, if the permissions are to be applied on all the recipients in the workflow.
required	object (Models.TemplatePermission) TemplatePermission

Responses

Request samples

Payload

Content type

application/json

{"apply_to_all": true,
"permissions": {"print": true,
"artificial_intelligence": {"enabled": true
},
"download": true,
"add_text": true,
"change_recipients": true,
"add_attachment": true,
"legal_notice": {"enabled": true,
"legal_notice_name": "string"
},
"attachment_preview": {"enabled": true
}
}
}

Response samples

400
401
403
404
500

Content type

application/json

{"Message": "string"
}

Get Workflow User Authentication (Document Opening) (Template)

Business applications can use this service API to get the access security settings enabled for personal/enterprise template. Recipients will not be able to access document package outside the scope of this duration if the access security is enabled.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
order required	integer <int32> The Order of the recipient in the template workflow for which the access security and authentication is 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

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"authentication": {"enabled": true,
"password": {"enabled": true,
"user_password": "string"
},
"sms_otp": {"enabled": true,
"otp_length": 0,
"retry_duration": 0,
"mobile_number": "string",
"methods": ["string"
]
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"identity_verification_policy": {"id": 0,
"name": "string"
}
}
},
"authentication_signing": {"enabled": true,
"sms_otp": {"otp_length": 0,
"retry_duration": 0,
"mobile_number": "string",
"methods": ["string"
]
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"identity_verification_policy": {"id": 0,
"name": "string"
}
}
},
"access_duration": {"enabled": true,
"duration_by_date": {"enabled": true,
"accessible": true,
"duration": {"start_date_time": "string",
"end_date_time": "string"
}
},
"duration_by_days": {"enabled": true,
"accessible": true,
"duration": {"total_days": 0
}
}
}
}

Update Workflow User Authentication (Document Opening) (Template)

Business applications can use this service API to update the authentications and access duration for a user that has already been added to a personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template for which workflow access security and authentication is to be updated.
order required	integer <int32> The Order of the recipient in the workflow for which the access security and authentication is 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:
application/json

apply_to_all	boolean True, if the access security or authentications are to be applied on all the recipients in the workflow.
required	object (Models.AccessAuthentication) AccessAuthentication
	object (Models.SigningAuthentication) SigningAuthentication
required	object (Models.PermissionAccessDuration) PermissionAccessDuration

Responses

Request samples

Payload

Content type

application/json

{"apply_to_all": true,
"authentication": {"enabled": true,
"password": {"enabled": true,
"user_password": "string"
},
"sms_otp": {"enabled": true,
"mobile_number": "string"
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"identity_verification_policy": {"id": 0
}
}
},
"authentication_signing": {"enabled": true,
"sms_otp": {"mobile_number": "string"
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"identity_verification_policy": {"id": 0
}
}
},
"access_duration": {"enabled": true,
"duration_by_date": {"enabled": true,
"duration": {"start_date_time": "2019-08-24T14:15:22Z",
"end_date_time": "2019-08-24T14:15:22Z"
}
},
"duration_by_days": {"enabled": true,
"duration": {"total_days": 0
}
}
}
}

Response samples

400
401
403
404
500

Content type

application/json

{"Message": "string"
}

Get Workflow Reminder (Template)

Business applications can use this service API to update the reminders for the recipients that has already been added to a personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
order required	integer <int32> The order of the user for which the template workflow reminders 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

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"enabled": true,
"frequency": "string",
"remind_after": 0,
"repeat": {"enabled": true,
"frequency": "string",
"keep_reminding_after": 0,
"total_reminders": 0
}
}

Update Workflow Reminders (Template)

Business applications can use this service API to update the workflow reminders for a recipient that has already been added to a personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template for which workflow reminders to be updated.
order required	integer <int32> The order of the user for which the template reminders 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:
application/json

apply_to_all	boolean True, if reminder settings are to be applied on all the recipients in the workflow.
enabled	boolean True, if reminder settings are to be enabled.
frequency	string (Models.Frequency) Enum: "DAYS" "HOURS"
remind_after	integer <int32> Required, in case of enabled property will true. The number of days after which the first reminder would be sent to workflow user.
	object (Models.TemplateRepeatRequest) TemplateRepeatRequest

Responses

Request samples

Payload

Content type

application/json

{"apply_to_all": true,
"enabled": true,
"frequency": "DAYS",
"remind_after": 0,
"repeat": {"enabled": true,
"frequency": "DAYS",
"keep_reminding_after": 0,
"total_reminders": 0
}
}

Response samples

400
401
403
404
500

Content type

application/json

{"Message": "string"
}

Get Workflow Details (Template)

Business applications can use this service API to get workflow details of the personal/enterprise template. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.

path Parameters

templateId

required

integer <int32>

The ID of personal/enterprise template.

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

200
401
403
404
500

Content type

application/json

{"template_id": 0,
"template_name": "string",
"uploaded_on": "string",
"modified_on": "string",
"enterprise": true,
"description": "string",
"read_only": true,
"public": true,
"workflow": {"workflow_type": "string",
"continue_on_decline": true,
"message": "string",
"post_process": {"enabled": true,
"contacts": ["string"
],
"recipients": [{"name": "string",
"email": "string"
}
],
"message": "string",
"google_drive": true,
"one_drive": true,
"dropbox": true,
"workflow_recipients": true,
"document_processing_report": true
},
"comments": true
},
"documents": [{"document_id": 0,
"document_name": "string",
"document_order": 0,
"document_height": 0,
"document_width": 0,
"document_pages": 0,
"created_on": "string",
"modified_on": "string",
"form_fields": true,
"certify": {"enabled": true,
"allowed_permissions": ["string"
],
"default_permission": "string"
},
"lock_form_fields": true
}
],
"users": [{"order": 0,
"user_name": "string",
"user_email": "string",
"user_photo_url": "string",
"group_name": "string",
"group_members": ["string"
],
"role": "string",
"placeholder": "string",
"permission": {"print": true,
"artificial_intelligence": {"enabled": true
},
"download": true,
"add_text": true,
"change_recipients": true,
"add_attachment": true,
"legal_notice": {"enabled": true,
"allowed_notices": [{"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
],
"default_notice": {"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
},
"attachment_preview": {"enabled": true
}
},
"authentications": {"authentication": {"enabled": true,
"password": {"enabled": true,
"user_password": "string"
},
"sms_otp": {"enabled": true,
"otp_length": 0,
"retry_duration": 0,
"mobile_number": "string",
"methods": ["string"
]
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"identity_verification_policy": {"id": 0,
"name": "string"
}
}
},
"authentication_signing": {"enabled": true,
"sms_otp": {"otp_length": 0,
"retry_duration": 0,
"mobile_number": "string",
"methods": ["string"
]
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"identity_verification_policy": {"id": 0,
"name": "string"
}
}
},
"access_duration": {"enabled": true,
"duration_by_date": {"enabled": true,
"accessible": true,
"duration": {"start_date_time": "string",
"end_date_time": "string"
}
},
"duration_by_days": {"enabled": true,
"accessible": true,
"duration": {"total_days": 0
}
}
}
},
"reminder": {"enabled": true,
"frequency": "string",
"remind_after": 0,
"repeat": {"enabled": true,
"frequency": "string",
"keep_reminding_after": 0,
"total_reminders": 0
}
},
"signing_order": 0,
"user_national_id": "string",
"guest_user": true,
"email_language_code": "string",
"electronic_seal": {"name": "string",
"level_of_assurance": "string"
},
"mobile_number": "string",
"delivery_method": "string",
"logged_in_user": true
}
]
}

Update Workflow Details (Template)

Business applications can use this service API to update the workflow details of the personal/enterprise template.

path Parameters

templateId

required

integer <int32>

The ID of personal/enterprise template.

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:
application/json

workflow_type	string (Models.WorkflowType) Enum: "SERIAL" "INDIVIDUAL" "PARALLEL" "CUSTOM"
continue_on_decline	boolean or null True, if workflow needs to continue even if any recipient declines the document. If no value is provided, old value will be retained.
message	string or null <= 1500 characters A custom string message from the document owner to every recipient, this message appears in the sharing email as well as on the screen. If no value is provided, old value will be retained.
comments	boolean or null Allow comments,If no value is provided, old value will be retained.

Responses

Request samples

Payload

Content type

application/json

{"workflow_type": "SERIAL",
"continue_on_decline": true,
"message": "string",
"comments": true
}

Response samples

400
401
403
404
500

Content type

application/json

{"Message": "string"
}

Update Post Processing (Template)

Business applications can use this service API to update post processing of the personal/enterprise template.

path Parameters

templateId

required

integer <int32>

The ID of personal/enterprise template.

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:
application/json

enabled required	boolean True, if post processing is turned on for the package.
contacts	Array of strings or null
	Array of objects or null (Models.PostProcessRecipientRequest) List of the name and email addresses to whom the emails are sent when the post processing is executed after the workflow completion.
message	string or null <= 1500 characters A custom string message for all the contacts. Message becomes part of the email sent to the contacts.
google_drive	boolean True, if document is to be uploaded to the provided google account after the workflow completion.
dropbox	boolean True, if document is to be uploaded to the provided dropbox account after the workflow completion.
onedrive	boolean True, if document is to be uploaded to the provided oneDrive account after the workflow completion.
workflow_recipients	boolean True, if workflow completion report is to be sent to all recipients of the workflow when post processing is executed. Default value is false.
document_processing_report	boolean True, if Send the document processing report (XML) is to be enabled to for the workflow

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"contacts": ["string"
],
"recipients": [{"name": "string",
"email": "string"
}
],
"message": "string",
"google_drive": true,
"dropbox": true,
"onedrive": true,
"workflow_recipients": true,
"document_processing_report": true
}

Response samples

400
403
404
500

Content type

application/json

{"Message": "string"
}

Fields Management

APIs for managing document fields within templates, including creation, updates, assignment, replication, and deletion.

Add Attachment Field (Template)

Business applications can use this service API to add an attachment field to a document into personal/enterprise template.

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 to Template 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

templateId required	integer <int32> The ID of personal/enterprise template to which the field 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:
application/json

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

Payload

Content type

application/json

{"order": 0,
"page_no": 0,
"field_name": "string",
"validation_rule": "OPTIONAL",
"note": "string",
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
}
}

Response samples

Content type

application/json

{"field_name": "string",
"field_locale": "string",
"font": {"name": "string",
"size": 0,
"embedded_size": 0
}
}

Update Attachment Field (Template)

Business applications can use this service API to update an attachment field of a document into personal/enterprise template.

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 of Template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field is updated.
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:
application/json

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

Payload

Content type

application/json

{"field_name": "string",
"renamed_as": "string",
"page_no": 0,
"validation_rule": "OPTIONAL",
"note": "string",
"dimensions": {"x": 0,
"y": 0
}
}

Response samples

Content type

application/json

{"Message": "string"
}

Add CheckBox Field (Template)

Business applications can use this service API to add a checkbox field into personal/enterprise template.

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 to Template for more information.

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

templateId required	integer <int32> The ID of personal/enterprise template to which the field 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:
application/json

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 provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.
value	boolean Value
required	object (Models.FieldDimension) FieldDimension
validation_rule	string (Models.ValidationRule) Enum: "OPTIONAL" "MANDATORY"

Responses

Request samples

Payload

Content type

application/json

{"order": 0,
"page_no": 0,
"field_name": "string",
"value": true,
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"validation_rule": "OPTIONAL"
}

Response samples

Content type

application/json

{"field_name": "string",
"field_locale": "string",
"font": {"name": "string",
"size": 0,
"embedded_size": 0
}
}

Update CheckBox Field (Template)

Business applications can use this service API to update a checkbox field of a document into personal/enterprise template.

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 of Template.

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

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field is updated.
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:
application/json

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.
value	boolean Value of the field.
required	object (Models.FieldDimension) FieldDimension
validation_rule	string (Models.ValidationRule) Enum: "OPTIONAL" "MANDATORY"

Responses

Request samples

Payload

Content type

application/json

{"field_name": "string",
"renamed_as": "string",
"page_no": 0,
"value": true,
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"validation_rule": "OPTIONAL"
}

Response samples

Content type

application/json

{"Message": "string"
}

Update DropDown Field (Template)

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

path Parameters

templateId required	integer <int32> 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:
application/json

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

Payload

Content type

application/json

{"field_name": "string",
"validation_rule": "OPTIONAL"
}

Response samples

401
404
500

Content type

application/json

{"Message": "string"
}

Assign Document Field (Template)

Business applications can use this service API to assign users to input fields, e.g. form 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.

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

templateId required	integer <int32> The ID of personal/enterprise template.
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:
application/json

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

Payload

Content type

application/json

[{"field_name": "string",
"radio_group_name": "string",
"order": 0,
"level_of_assurance": ["string"
]
}
]

Response samples

401
403
404
500

Content type

application/json

{"Message": "string"
}

Add Initial Field (Template)

Business applications can use this service API to add an initials field to a document into personal/enterprise template.

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 to Template 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

templateId required	integer <int32> The ID of personal/enterprise template to which the field 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:
application/json

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.
required	object (Models.FieldDimension) FieldDimension
last_page	boolean Last Page

Responses

Request samples

Payload

Content type

application/json

{"order": 0,
"page_no": 0,
"field_name": "string",
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"last_page": true
}

Response samples

Content type

application/json

{"field_name": "string",
"field_locale": "string",
"font": {"name": "string",
"size": 0,
"embedded_size": 0
}
}

Update Initial Field (Template)

Business applications can use this service API to update an initials field of a document into personal/enterprise template.

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 of Template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field is updated.
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:
application/json

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.
required	object (Models.FieldDimension) FieldDimension
last_page	boolean Last Page

Responses

Request samples

Payload

Content type

application/json

{"field_name": "string",
"renamed_as": "string",
"page_no": 0,
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"last_page": true
}

Response samples

Content type

application/json

{"Message": "string"
}

Replicate Initial Fields (Template)

Business applications can use this service API to replicate initials fields to the multiple pages of a document into personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
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:
application/json

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

Payload

Content type

application/json

{"pages": [0
]
}

Response samples

Content type

application/json

[{"order": 0,
"page_no": 0,
"field_name": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
}
}
]

Add In-person Field (Template)

Business applications can use this service API to an add in-person signature field to a document into personal/enterprise template.

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 to Template for more information.

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

templateId required	integer <int32> The ID of personal/enterprise template to which the field 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:
application/json

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.
placeholder required	string [ 1 .. 255 ] characters String identifier for the in-person field, it can be Customer, Jack, CEO etc.
required	object (Models.FieldDimension) FieldDimension
display	string (Models.DisplayType) Enum: "VISIBLE" "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
last_page	boolean Last Page

Responses

Request samples

Payload

Content type

application/json

{"order": 0,
"page_no": 0,
"field_name": "string",
"placeholder": "string",
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"display": "VISIBLE",
"level_of_assurance": ["string"
],
"authentication_signing": {"enabled": true,
"otp": {"enabled": true,
"mobile_number": "string"
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"policy": {"id": 0
}
}
},
"last_page": true
}

Response samples

Content type

application/json

{"field_name": "string",
"field_locale": "string",
"font": {"name": "string",
"size": 0,
"embedded_size": 0
}
}

Update In-person Field (Template)

Business applications can use this service API to update an in-person signature field of a document into personal/enterprise template.

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 of Template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field is updated.
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:
application/json

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.
placeholder required	string [ 1 .. 255 ] characters String identifier for the in-person field, it can be Customer, Jack, CEO etc.
required	object (Models.FieldDimension) FieldDimension
display	string (Models.DisplayType) Enum: "VISIBLE" "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
last_page	boolean Last Page

Responses

Request samples

Payload

Content type

application/json

{"field_name": "string",
"renamed_as": "string",
"page_no": 0,
"placeholder": "string",
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"display": "VISIBLE",
"level_of_assurance": ["string"
],
"authentication_signing": {"enabled": true,
"otp": {"enabled": true,
"mobile_number": "string"
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"policy": {"id": 0
}
}
},
"last_page": true
}

Response samples

Content type

application/json

{"Message": "string"
}

Replicate In-person Fields (Template)

Business applications can use this service API to replicate In-person fields to the multiple pages of a document into personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
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:
application/json

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

Payload

Content type

application/json

{"pages": [0
]
}

Response samples

Content type

application/json

[{"order": 0,
"page_no": 0,
"field_name": "string",
"placeholder": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"display": "string",
"level_of_assurance": ["string"
],
"authentication_signing": {"enabled": true,
"otp": {"enabled": true,
"mobile_number": "string"
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"policy": {"id": 0
}
}
}
}
]

Add QR Code (Template)

Business applications can use this service API to add a QR Code field into personal/enterprise template.

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 to Template for more information.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field 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:
application/json

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

Payload

Content type

application/json

{"page_no": 0,
"field_name": "string",
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"data": "string",
"options": {"error_correction_level": "Default",
"encoding": "Default",
"pixels_per_module": 0,
"add_margins": true
},
"color": {"dots": "string",
"background": "string"
},
"logo": {"base64": "string",
"hide_background_dots": true,
"size": 0
}
}

Response samples

Content type

application/json

{"data": "string",
"field_name": "string",
"value": "string"
}

Update QR Code (Template)

Business applications can use this service API to update a QR Code field of a document into personal/enterprise template.

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 of Template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field is updated.
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:
application/json

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

Payload

Content type

application/json

{"field_name": "string",
"renamed_as": "string",
"page_no": 0,
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"data": "string",
"options": {"error_correction_level": "Default",
"encoding": "Default",
"pixels_per_module": 0,
"add_margins": true
},
"color": {"dots": "string",
"background": "string"
},
"logo": {"base64": "string",
"hide_background_dots": true,
"size": 0
}
}

Response samples

Content type

application/json

{"value": "string"
}

Add RadioBox Field (Template)

Business applications can use this service API to add a radio button field into personal/enterprise template.

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 to Template for more information.

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

templateId required	integer <int32> The ID of personal/enterprise template to which the field 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:
application/json

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 provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.
value	boolean Value
validation_rule	string (Models.ValidationRule) Enum: "OPTIONAL" "MANDATORY"
radio_group_name required	string [ 1 .. 255 ] characters
required	object (Models.FieldDimension) FieldDimension

Responses

Request samples

Payload

Content type

application/json

{"order": 0,
"page_no": 0,
"field_name": "string",
"value": true,
"validation_rule": "OPTIONAL",
"radio_group_name": "string",
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
}
}

Response samples

Content type

application/json

{"field_name": "string",
"field_locale": "string",
"font": {"name": "string",
"size": 0,
"embedded_size": 0
}
}

Update RadioBox Field (Template)

Business applications can use this service API to update a radio button field of a document into personal/enterprise template.

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 of Template.

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

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field is updated.
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:
application/json

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.
value	boolean Value of the field.
validation_rule	string (Models.ValidationRule) Enum: "OPTIONAL" "MANDATORY"
radio_group_name required	string [ 1 .. 255 ] characters The group name to which the field belongs.
required	object (Models.FieldDimension) FieldDimension

Responses

Request samples

Payload

Content type

application/json

{"field_name": "string",
"renamed_as": "string",
"page_no": 0,
"value": true,
"validation_rule": "OPTIONAL",
"radio_group_name": "string",
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
}
}

Response samples

Content type

application/json

{"Message": "string"
}

Add Electronic Seal (Template)

Business applications can use this service API to add an Electronic Seal recipient of the personal/enterprise template. This call will only add a recipient to the template. That is, no fields currently on the document will be automatically assigned to the new Electronic Seal recipient(s), nor will this create any new fields. Note the Electronic Seal recipient(s) will be added as the last person in the workflow. Hence further work may be required to remove a current Electronic Seal recipient(s) already present in the workflow. At least one recipient must exist in a workflow before fields can be added to the document. Note: the input accepts one or more Electronic Seal recipient(s) in a single call.

path Parameters

templateId

required

integer <int32>

The ID of personal/enterprise template.

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:
application/json

Array

name required	string [ 1 .. 255 ] characters The name of the new user to be added/updated in workflow. If no value is provided, old value will be retained.
signing_order	integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

Responses

Request samples

Payload

Content type

application/json

[{"name": "string",
"signing_order": 0
}
]

Response samples

Content type

application/json

[{"name": "string",
"signing_order": 0,
"level_of_assurance": "string"
}
]

Update Electronic Seal (Template)

Business applications can use this service API to update the details of an Electronic Seal recipient who has already been added to a workflow of the personal/enterprise template. Normally this call is useful after a template has been applied to a document and business applications wants to override the details of a specific Electronic Seal recipient within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow. Note: only PDF type document is supported

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
order required	integer <int32> The order of the eseal recipient in template.

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:
application/json

name required	string [ 1 .. 255 ] characters The name of the new user to be added/updated in workflow. If no value is provided, old value will be retained.
signing_order	integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"signing_order": 0
}

Response samples

Content type

application/json

{"name": "string",
"signing_order": 0,
"level_of_assurance": "string"
}

Add Digital Signature Field (Template)

Business applications can use this service API to add a digital signature field to a document into personal/enterprise template.

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 to Template for more information.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field is added.
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:
application/json

order required	integer <int32> Order of the recipient for which the field is being created.
page_no required	integer <int32> Page number at which the field is about 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.
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"
required	object (Models.FieldDimension) FieldDimension
display	string (Models.DisplayType) Enum: "VISIBLE" "INVISIBLE"
	object (Models.SignatureFieldAuthentication) SignatureFieldAuthentication
last_page	boolean Last Page

Responses

Request samples

Payload

Content type

application/json

{"order": 0,
"page_no": 0,
"field_name": "string",
"level_of_assurance": ["string"
],
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"display": "VISIBLE",
"authentication_signing": {"enabled": true,
"otp": {"enabled": true,
"mobile_number": "string"
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"policy": {"id": 0
}
}
},
"last_page": true
}

Response samples

Content type

application/json

{"field_name": "string",
"created_on": "string"
}

Update Digital Signature Field (Template)

Business applications can use this service API to update a digital signature field of a document into personal/enterprise template.

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 of Template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field is updated.
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:
application/json

field_name required	string [ 1 .. 255 ] characters 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 <= 255 characters Updated name of the field if renaming of the field is intended.
page_no required	integer <int32> Page number on which the field is to be created.
required	object (Models.FieldDimension) FieldDimension
display	string (Models.DisplayType) Enum: "VISIBLE" "INVISIBLE"
	object (Models.SignatureFieldAuthentication) SignatureFieldAuthentication
last_page	boolean Last Page

Responses

Request samples

Payload

Content type

application/json

{"field_name": "string",
"level_of_assurance": ["string"
],
"renamed_as": "string",
"page_no": 0,
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"display": "VISIBLE",
"authentication_signing": {"enabled": true,
"otp": {"enabled": true,
"mobile_number": "string"
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"policy": {"id": 0
}
}
},
"last_page": true
}

Response samples

Content type

application/json

{"Message": "string"
}

Add Stamp Field (Template)

Business applications can use this service API to add an stamp field to a document into personal/enterprise template.

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 to Template 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

templateId required	integer <int32> The ID of personal/enterprise template to which the field 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:
application/json

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.
required	object (Models.FieldDimension) FieldDimension
last_page	boolean Last Page
validation_rule required	string (Models.StampValidationRule) Enum: "MANDATORY" "OPTIONAL"

Responses

Request samples

Payload

Content type

application/json

{"order": 0,
"page_no": 0,
"field_name": "string",
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"last_page": true,
"validation_rule": "MANDATORY"
}

Response samples

Content type

application/json

{"field_name": "string",
"validation_rule": "MANDATORY"
}

Update Stamp Field (Template)

Business applications can use this service API to update an stamp field of a document into personal/enterprise template.

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 of Template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field is updated.
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:
application/json

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.
required	object (Models.FieldDimension) FieldDimension
last_page	boolean Last Page
validation_rule required	string (Models.StampValidationRule) Enum: "MANDATORY" "OPTIONAL"

Responses

Request samples

Payload

Content type

application/json

{"field_name": "string",
"renamed_as": "string",
"page_no": 0,
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"last_page": true,
"validation_rule": "MANDATORY"
}

Response samples

Content type

application/json

{"Message": "string"
}

Replicate Stamp Fields (Template)

Business applications can use this service API to replicate stamps fields to the multiple pages of a document into personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
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:
application/json

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

Payload

Content type

application/json

{"pages": [0
]
}

Response samples

Content type

application/json

[{"order": 0,
"page_no": 0,
"field_name": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"validation_rule": "MANDATORY"
}
]

Add TextBox Field (Template)

Business applications can use this service API to add a text input field into personal/enterprise template.

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 to Template for more information.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field 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:
application/json

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.
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 <= 255 characters 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 <= 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.
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.FieldValidationValueRequest) FieldValidationValueRequest
required	object (Models.TemplateFont) TemplateFont
required	object (Models.FieldDimension) FieldDimension
multiline	boolean If set to true, text area field would be created

Responses

Request samples

Payload

Content type

application/json

{"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": {"rules": [{"type": "string",
"value": "string"
}
]
},
"font": {"name": "string",
"size": "string",
"embedded_size": "string"
},
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"multiline": true
}

Response samples

Content type

application/json

{"field_name": "string",
"field_locale": "string",
"font": {"name": "string",
"size": 0,
"embedded_size": 0
}
}

Update TextBox Field (Template)

Business applications can use this service API to update a text input field of a document into personal/enterprise template.

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 of Template. The latter can be used when a template was applied or the document was created using the GUI interface.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field is updated.
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:
application/json

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.
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.
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
field_type	string (Models.FieldType) Enum: "Number" "Text"
validation_rule	string (Models.ValidationRule) Enum: "OPTIONAL" "MANDATORY"
	object (Models.TemplateFont) TemplateFont
	object (Models.FieldDimension) FieldDimension
placeholder	string or null <= 255 characters 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

Payload

Content type

application/json

{"field_name": "string",
"renamed_as": "string",
"page_no": 0,
"value": "string",
"field_locale": "string",
"max_length": 0,
"field_type": "Number",
"validation_rule": "OPTIONAL",
"font": {"name": "string",
"size": "string",
"embedded_size": "string"
},
"dimensions": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"placeholder": "string",
"format": "string",
"validation": {"required": true,
"rules": [{"type": "string",
"value": "string"
}
]
}
}

Response samples

Content type

application/json

{"Message": "string"
}

Get Document Fields (Template)

Business applications can use this service API to get document fields of the personal/enterprise template. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
documentId required	integer <int64> The ID of the template document.
pageNo required	integer <int32> Default: 0 The 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

Responses

Response samples

Content type

application/json

{"signature": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"created_on": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"nid": "string",
"display": "string",
"level_of_assurance": ["string"
],
"authentication": {"enabled": true,
"sms_otp": {"enabled": true,
"otp_length": 0,
"retry_duration": 0,
"mobile_number": "string",
"methods": ["string"
]
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"policy": {"id": 0,
"name": "string"
}
}
},
"last_page": true
}
],
"hand_signature": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"last_page": true,
"nid": "string"
}
],
"electronic_signature": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"signature_sub_type": "string",
"authentication": {"enabled": true,
"sms_otp": {"enabled": true,
"otp_length": 0,
"retry_duration": 0,
"mobile_number": "string",
"methods": ["string"
]
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"policy": {"id": 0,
"name": "string"
}
}
},
"nid": "string",
"display": "string",
"last_page": true
}
],
"initials": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"last_page": true
}
],
"stamps": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"last_page": true,
"validation_rule": "MANDATORY"
}
],
"in_person_signature": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"placeholder": "string",
"signature_sub_type": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"display": "string",
"level_of_assurance": ["string"
],
"authentication": {"enabled": true,
"sms_otp": {"enabled": true,
"otp_length": 0,
"retry_duration": 0,
"mobile_number": "string",
"methods": ["string"
]
},
"totp": {"enabled": true
},
"identity_verification": {"enabled": true,
"policy": {"id": 0,
"name": "string"
}
}
},
"last_page": true
}
],
"text": [{"required": true,
"order": 0,
"tab_order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"value": "string",
"read_only": true,
"validation_rule": "string",
"validation": {"required": true,
"rules": [{"type": "string",
"value": "string"
}
]
},
"visible": true,
"multiline": true,
"field_locale": "string",
"font": {"name": "string",
"size": 0,
"embedded_size": 0
},
"max_length": 0,
"format_type": "string",
"placeholder": "string",
"format": "string",
"color": "string",
"embedded": true,
"border_color": "string",
"tooltip": "string",
"field_rotation": 0,
"align": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
}
}
],
"radio": [{"required": true,
"order": 0,
"tab_order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"value": true,
"read_only": true,
"validation_rule": "string",
"radio_group_name": "string",
"checked": true,
"visible": true,
"color": "string",
"embedded": true,
"border_color": "string",
"tooltip": "string",
"field_rotation": 0,
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
}
}
],
"checkbox": [{"required": true,
"order": 0,
"tab_order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"type": "string",
"value": true,
"read_only": true,
"checked": true,
"visible": true,
"validation_rule": "string",
"color": "string",
"embedded": true,
"border_color": "string",
"tooltip": "string",
"field_rotation": 0,
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
}
}
],
"dropdown": [{"required": true,
"order": 0,
"tab_order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"validation_rule": "string",
"read_only": true,
"value": "string",
"choices": ["string"
],
"visible": true,
"color": "string",
"embedded": true,
"border_color": "string",
"tooltip": "string",
"field_rotation": 0,
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"font": {"name": "string",
"size": 0,
"embedded_size": 0
}
}
],
"listbox": [{"order": 0,
"tab_order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"validation_rule": "string",
"read_only": true,
"value": "string",
"choices": ["string"
],
"visible": true,
"color": "string",
"embedded": true,
"border_color": "string",
"tooltip": "string",
"field_rotation": 0,
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"font": {"name": "string",
"size": 0,
"embedded_size": 0
}
}
],
"qrcode": [{"field_name": "string",
"type": "string",
"page_no": 0,
"value": "string",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
},
"data": "string",
"options": {"error_correction_level": "Default",
"encoding": "Default",
"pixels_per_module": 0,
"add_margins": true
},
"color": {"dots": "string",
"background": "string"
},
"logo": {"base64": "string",
"hide_background_dots": true,
"size": 0
}
}
],
"attachment": [{"order": 0,
"display_order": 0,
"field_name": "string",
"page_no": 0,
"attachmentRefId": 0,
"note": "string",
"validation_rule": "OPTIONAL",
"dimensions": {"field": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"page": {"width": 0,
"height": 0
}
}
}
]
}

Delete Document Field (Template)

Business applications can use this service API to delete a field of document into personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field is deleted.
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:
application/json

field_name

required

string non-empty

Name of the field to be deleted.

Responses

Request samples

Payload

Content type

application/json

{"field_name": "string"
}

Response samples

400
401
403
404
500

Content type

application/json

{"Message": "string"
}

Bulk Delete Document Field (Template)

Business applications can use this service API to bulk delete the fields of document into personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template to which the field is deleted.
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:
application/json

field_names

required

Array of strings

Name of the field to be deleted.

Responses

Request samples

Payload

Content type

application/json

{"field_names": ["string"
]
}

Response samples

400
401
403
404
500

Content type

application/json

{"Message": "string"
}

Document Management

APIs for accessing template document content, document images, thumbnails, certification policies, and document-related settings.

Get Document Image (Template)

Business applications can use this service API to get an image of a particular page as identified by the pageNo. 800x600 can be replaced by any given resolution to match the device displaying resolution.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
documentId required	integer <int64> The ID of the document for which the image is to be requested.
pageNo required	integer <int32> The Page number in the document for which the image is requested.
widthHeight required	string Dimensions are provided in the URL in the form of width x height. This width height can be any value desired by the client application. Width and height are calculated in pixels.

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-page-width	string Default: 600 Width of the image returned in response.
x-page-height	string Default: 800 Height of the image returned in response.

Responses

Response samples

200
401
403
404
500

Content type

application/json

"string"

Get Document Image (Base64) (Template)

Business applications can use this service API to get an image of a particular page as identified by the pageNo. 800x600 can be replaced by any given resolution to match the device displaying resolution.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
documentId required	integer <int64> The ID of the document for which the image is to be requested.
pageNo required	integer <int32> Page number in the document for which the image is requested.
widthHeight required	string Dimensions are provided in the URL in the form of width x height. This width height can be any value desired by the client application. Width and height are calculated in pixels.

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-page-width	string Default: 600 Width of the image returned in response.
x-page-height	string Default: 800 Height of the image returned in response.

Responses

Response samples

200
401
403
404
500

Content type

application/json

"string"

Get Template Document Thumbnails (Base64)

Business applications can use this service API to get list of thumbnails of a particular pages as identified by the fromPage and toPage.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
documentId required	integer <int64> The ID of the document for which the thumbnails is to be requested.
fromPage required	integer <int32> Start page number in the document for which the thumbnails is requested. It must be smaller than toPage value
toPage required	integer <int32> End page number in the document for which the thumbnails is requested.
pageWidth required	integer <int32> Width of the viewing area of the page. Maximum with can be passed as 512, recommended is 133

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

Responses

Response samples

Content type

application/json

[{"page_no": 0,
"image_base64": "string"
}
]

Update Certify Policy (Template)

Business applications can use this service API to update certify signature settings for a document of the personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
documentId required	integer <int64> The ID of the document on which the action is to be performed.

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:
application/json

	object (Models.CertifyPolicyRequest) CertifyPolicyRequest
lock_form_fields	boolean True if form fields are to be locked after the last signature on the current document.

Responses

Request samples

Payload

Content type

application/json

{"certify": {"enabled": true,
"permission": "NO_CHANGES_ALLOWED"
},
"lock_form_fields": true
}

Response samples

401
403
404
500

Content type

application/json

{"Message": "string"
}

Recipients Managment

APIs for managing template recipients, placeholders, groups, recipient imports, and signing order.

Add Logged In User to Workflow (Template)

Business applications can use this service API to add Logged In User to a workflow of the personal/enterprise template.

path Parameters

templateId

required

integer <int32>

The ID of personal/enterprise template.

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:
application/json

Array

email_notification	boolean Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn.
role	string (Models.WorkflowCollaboratorRole) Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY"
signing_order	integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

Responses

Request samples

Payload

Content type

application/json

[{"email_notification": true,
"role": "SIGNER",
"signing_order": 0
}
]

Response samples

Content type

application/json

[{"user_email": "string",
"signing_order": 0,
"guest_user": true,
"email_language_code": "string",
"permission": {"print": true,
"download": true,
"add_text": true,
"change_recipients": true,
"add_attachment": true,
"legal_notice": {"enabled": true,
"allowed_notices": [{"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
],
"default_notice": {"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
},
"attachment": {"enabled": true
},
"artificial_intelligence": {"enabled": true
},
"attachment_preview": {"enabled": true
}
},
"reminder": {"enabled": true,
"frequency": "string",
"remind_after": 0,
"repeat": {"enabled": true,
"frequency": "string",
"keep_reminding_after": 0,
"total_reminders": 0
}
}
}
]

Add Users to Workflow (Template)

Business applications can use this service API to add recipients to a workflow of the personal/enterprise template. This call will only add a recipient to the template workflow. That is, no fields currently on the document will be automatically assigned to the new recipient(s), nor will this create any new fields.

Note the recipient(s) will be added as the last person in the workflow.Hence further work may be required to remove a current recipient(s) already present in the workflow.

At least one user must exist in a workflow before fields (input and signature) can be added to the document.

Note the input accepts one or more users in a single call.

Note SigningHub workflow signing order starts at "1". Hence, adding a user to workflow with no current recipient(s) begins a new signing order count.The "signing_order" parameter is mandatory if the workflow type is "custom".

Important, using this API call may affect the workflow type.If there are current recipients in a sequential workflow and a new one is added with the same signing order as a current recipient, then that part of the workflow changes automatically from sequential to parallel.Hence, the workflow overall is now of type custom as opposed to purely sequential. Adding a recipient with the same signing order as two or parallel recipients does not change the workflow.There are merely, three or more recipients at that particular point of the workflow; all in parallel order.

path Parameters

templateId

required

integer <int32>

The ID of personal/enterprise template.

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:
application/json

Array

user_email	string or null <= 255 characters Email address of the user to be added in the workflow.
user_name required	string [ 1 .. 255 ] characters Name of the recipient to be added in the workflow.
email_notification	boolean If set as true, SigningHub will send notifications to the user via email as per the document owner and user notification settings. A value of false means no notifications will be sent to user throughout the workflow.
role	string (Models.WorkflowCollaboratorRole) Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY"
signing_order	integer or null <int32> Order of the recipient in the workflow. This signing order is mandatory when workflow type is "CUSTOM".
delivery_method	string (Enumerations.DeliveryMethod) Enum: "EMAIL" "SMS" "EMAIL_AND_SMS"
mobile_number	string or null <= 15 characters Mobile Number

Responses

Request samples

Payload

Content type

application/json

[{"user_email": "string",
"user_name": "string",
"email_notification": true,
"role": "SIGNER",
"signing_order": 0,
"delivery_method": "EMAIL",
"mobile_number": "string"
}
]

Response samples

Content type

application/json

[{"user_email": "string",
"signing_order": 0,
"guest_user": true,
"email_language_code": "string",
"permission": {"print": true,
"download": true,
"add_text": true,
"change_recipients": true,
"add_attachment": true,
"legal_notice": {"enabled": true,
"allowed_notices": [{"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
],
"default_notice": {"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
},
"attachment": {"enabled": true
},
"artificial_intelligence": {"enabled": true
},
"attachment_preview": {"enabled": true
}
},
"reminder": {"enabled": true,
"frequency": "string",
"remind_after": 0,
"repeat": {"enabled": true,
"frequency": "string",
"keep_reminding_after": 0,
"total_reminders": 0
}
}
}
]

Get Workflow Users (Template)

Business applications can use this service API to get workflow users of the personal/enterprise template. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.

path Parameters

templateId

required

integer <int32>

The ID of personal/enterprise template.

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

200
401
403
404
500

Content type

application/json

[{"order": 0,
"user_email": "string",
"user_name": "string",
"user_photo_url": "string",
"group_name": "string",
"group_members": [{"user_email": "string",
"user_name": "string"
}
],
"role": "string",
"placeholder": "string",
"signing_order": 0,
"user_national_id": "string",
"guest_user": true,
"email_language_code": "string",
"electronic_seal": {"name": "string",
"level_of_assurance": "string"
},
"mobile_number": "string",
"delivery_method": "string",
"logged_in_user": true
}
]

Add Placeholder to Workflow (Template)

Business applications can use this service API to add placeholder to a workflow of the personal/enterprise template. A place holder is required when you do not know the identity of the intended recipient in a workflow.

Note the placeholder will be added as the last user in the workflow.Hence further work may be required to remove a current user/group, already present in the workflow.

Adding a place holder allows you to proceed and add signature and/or input fields to the document, which can then be assigned to individual users at a later stage.

path Parameters

templateId

required

integer <int32>

The ID of personal/enterprise template.

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:
application/json

Array

placeholder required	string [ 1 .. 255 ] characters The name of the new placeholder to be added in workflow.
email_notification	boolean Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn.
role	string (Models.WorkflowCollaboratorRole) Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY"
signing_order	integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

Responses

Request samples

Payload

Content type

application/json

[{"placeholder": "string",
"email_notification": true,
"role": "SIGNER",
"signing_order": 0
}
]

Response samples

Content type

application/json

[{"permission": {"print": true,
"download": true,
"add_text": true,
"change_recipients": true,
"add_attachment": true,
"legal_notice": {"enabled": true,
"allowed_notices": [{"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
],
"default_notice": {"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
},
"attachment": {"enabled": true
},
"artificial_intelligence": {"enabled": true
},
"attachment_preview": {"enabled": true
}
},
"reminder": {"enabled": true,
"frequency": "string",
"remind_after": 0,
"repeat": {"enabled": true,
"frequency": "string",
"keep_reminding_after": 0,
"total_reminders": 0
}
},
"signing_order": 0
}
]

Add Groups to Workflow (Template)

Business applications can use this service API to add groups as a recipient to a workflow of the personal/enterprise template. A SigningHub group means any member of the group can perform the action, i.e. sign, on behalf of all members of the group.

Note the group will be added as the last user/group in the workflow.Hence further work may be required to remove a current user/group, already present in the workflow.

path Parameters

templateId

required

integer <int32>

The ID of personal/enterprise template.

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:
application/json

Array

group_name required	string [ 1 .. 255 ] characters The name of the new group to be added in workflow.
email_notification	boolean Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, default value of "true" will be set.
role	string (Models.WorkflowCollaboratorRole) Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY"
signing_order	integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

Responses

Request samples

Payload

Content type

application/json

[{"group_name": "string",
"email_notification": true,
"role": "SIGNER",
"signing_order": 0
}
]

Response samples

Content type

application/json

[{"permission": {"print": true,
"download": true,
"add_text": true,
"change_recipients": true,
"add_attachment": true,
"legal_notice": {"enabled": true,
"allowed_notices": [{"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
],
"default_notice": {"legal_notice_id": 0,
"legal_notice_name": "string",
"legal_notice_html": "string"
}
},
"attachment": {"enabled": true
},
"artificial_intelligence": {"enabled": true
},
"attachment_preview": {"enabled": true
}
},
"reminder": {"enabled": true,
"frequency": "string",
"remind_after": 0,
"repeat": {"enabled": true,
"frequency": "string",
"keep_reminding_after": 0,
"total_reminders": 0
}
},
"signing_order": 0
}
]

Update Workflow User (Template)

Business applications can use this service API to update the details of a recipient, group or place holder who has already been added to a personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
order required	integer <int32> The order of the user in template.

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:
application/json

user_email	string or null <= 255 characters The email address of the new user to be updated in workflow.
user_name	string or null <= 255 characters Name of the recipient to be updated. If no value is provided, old value will be retained.
email_notification	boolean or null Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained.
role	string (Models.WorkflowCollaboratorRole) Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY"
signing_order	integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".
email_language_code	string or null email language code
delivery_method	string (Enumerations.DeliveryMethod) Enum: "EMAIL" "SMS" "EMAIL_AND_SMS"
mobile_number	string or null <= 15 characters Mobile Number

Responses

Request samples

Payload

Content type

application/json

{"user_email": "string",
"user_name": "string",
"email_notification": true,
"role": "SIGNER",
"signing_order": 0,
"email_language_code": "string",
"delivery_method": "EMAIL",
"mobile_number": "string"
}

Response samples

Content type

application/json

{"user_email": "string",
"signing_order": 0,
"guest_user": true,
"email_language_code": "string"
}

Update Workflow Group (Template)

Business applications can use this service API to update the details of a group that has already been added to a personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
order required	integer <int32> The order of the user in template.

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:
application/json

group_name	string or null The name of the group to be updated in workflow. If no value is provided, old value will be retained.
email_notification	boolean or null Setting its value to "true" sends an email notification to the group members when their turn arrives in workflow. Setting its value to "false" does not send the email notification to the group members on their turn. If no value is provided, old value will be retained.
role	string (Models.WorkflowCollaboratorRole) Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY"
signing_order	integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

Responses

Request samples

Payload

Content type

application/json

{"group_name": "string",
"email_notification": true,
"role": "SIGNER",
"signing_order": 0
}

Response samples

400
401
403
404
500

Content type

application/json

{"Message": "string"
}

Update Placeholder (Template)

Business applications can use this service API to update a placeholder of the personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
order required	integer <int32> Order of the recipient in the workflow.

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:
application/json

placeholder	string or null The name of the new placeholder to be added in workflow. If no value is provided, old value will be retained.
email_notification	boolean or null Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained.
role	string (Models.WorkflowCollaboratorRole) Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY"
signing_order	integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

Responses

Request samples

Payload

Content type

application/json

{"placeholder": "string",
"email_notification": true,
"role": "SIGNER",
"signing_order": 0
}

Response samples

400
401
403
404
500

Content type

application/json

{"Message": "string"
}

Update Workflow Users Order (Template)

Business applications can use this service API to update order of the recipient in the workflow of the personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template
order required	integer <int32> Existing order of the recipient which is 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:
application/json

order

required

integer <int32>

The order of the recipient which is to be updated.

Responses

Request samples

Payload

Content type

application/json

{"order": 0
}

Response samples

400
401
403
404
500

Content type

application/json

{"Message": "string"
}

Delete Workflow User (Template)

Business applications can use this service API to delete recipient of the personal/enterprise template.

path Parameters

templateId required	integer <int32> The ID of personal/enterprise template.
order required	integer <int32> Order of the recipient in the template workflow which is to be deleted.

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

400
401
403
404
500

Content type

application/json

{"Message": "string"
}

Download Import Recipient Template (Template)

Business applications can use this service API to get recipient import template for personal/enterprise template.

path Parameters

templateId

required

integer <int32>

The ID of personal/enterprise template

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

200
401
403
404
500

Content type

application/json

"string"

Bulk Import Recipient (Template)

Business applications can use this service API to import the recipients into personal/enterprise template.

path Parameters

templateId

required

integer <int32>

The ID of personal/enterprise template

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
file (binary Stream)	string This is the recipient document in CSV format, posting via form data.

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"success": [{"user_name": "string",
"user_email": "string",
"signing_order": 0,
"guest_user": true,
"email_language_code": "string",
"delivery_method": "string",
"mobile_number": "string"
}
],
"failure": [{"user_name": "string",
"user_email": "string",
"error_message": "string"
}
]
}

Artificial Intelligence

APIs for utilizing Artificial Intelligence features and AI-assisted operations within templates.

Artificial Intelligence (AI) Execute Feature (Template)

Business applications can use this service API to execute artificial intelligence feature.

path Parameters

id required	integer <int32> Template Id
feature required	string Feature Id

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:
application/json

Request data

required

object (Custom.TemplateArtificialIntelligenceDocument)

Responses

Request samples

Payload

Content type

application/json

{"document": {"pages": [{"number": 0
}
]
}
}

Response samples

Content type

application/json

{"response": "string"
}

Artificial Intelligence (AI) Features (Template)

Business applications can use this service API to get artificial intelligence features.

path Parameters

id

required

integer <int32>

Template Id

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

200
401
403
500

Content type

application/json

{"features": [{"id": "string",
"name": "string",
"summary": "string",
"disclaimer": "string",
"default": true
}
]
}

SigningHub API Guide

Welcome

Template

Template Management

Get Enterprise Templates

path Parameters

query Parameters

header Parameters

Responses

Response samples

Export Enterprise Template

header Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/octet-streamtext/jsonmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Import Enterprise Template

header Parameters

Request Body schema: multipart/form-data

Responses

Response samples

Download Import Enterprise Template (Template)

header Parameters

Responses

Response samples

Add Enterprise Template

header Parameters

Request Body schema: multipart/form-data

Responses

Response samples

Bulk Delete Enterprise Template

header Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/octet-streamtext/jsonmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Add Personal Template to Enterprise

path Parameters

header Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/octet-streamtext/jsonmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Add Personal Template

header Parameters

Request Body schema: multipart/form-data

Responses

Response samples

Bulk Delete Personal Template

header Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/octet-streamtext/jsonmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Get Template by ID

path Parameters

header Parameters

Responses

Response samples

Delete Template

path Parameters

header Parameters

Responses

Response samples

Update Template

path Parameters

header Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/octet-streamtext/jsonmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Save Template

path Parameters

header Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/octet-streamtext/jsonmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Save Workflow as Template

path Parameters

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json