Get Workflow User Permissions - SigningHub-APIGuide

Business applications can use this service API to get document permissions for a recipient. Recipient is identified by the order in the workflow. The ID of the package is provided in the resource URL.

https://api.signinghub.com/v3/packages/{package_id}/workflow/{order}/permissions
HTTP Verb		GET
Content-Type		application/json
Accept		application/json
Authorization		Bearer {access_token}
Request Body		{ `"print":` `true,` `"download":` `false,` `"add_text":` `true,` `"add_attachment":` `false,` `"change_recipients":` `true,` `"legal_notice": {` `"enabled":` `true,` `"allowed_notices": [` `{` `"legal_notice_name":` `"legal notice 1",` `"legal_notice_html":` `"<table>...<\/table>"` `},` `{` `"legal_notice_name":` `"legal notice 1",` `"legal_notice_html":` `"<table>...<\/table>"` `}` `],` `"default_notice": {` `"legal_notice_name":` `"legal notice 1",` `"legal_notice_html":` `"<table>...<\/table>"` `}` `}` `}`
Status Code	Message	Response Body
200	OK
401	Unauthorized	`{` `"Message":` `"Request authorization denied"` `}`
		`{` `"Message":` `"User authentication required"` `}`
403	Forbidden	`{` `"Message":` `"Document does not belong to user"` `}`
		`{` `"Message":` `"Document is no longer in draft state"` `}`
		`{` `"Message":` `"Account is disabled"` `}`
404	Not Found	`{` `"Message":` `"Document not found"` `}`
		`{` `"Message":` `"Signature field not found"` `}`
500	Internal Server Error	`{` `"Message":` `"An internal server error occurred while processing the request"` `}`

The detail of each item provided in the request and response is provided below:

Item Details
Names	Description
Request Parameters
access_token	The access token obtained as a result of successful authentication. If "scope" parameter was used in authentication request, then this service requires the access token to be obtained using the credentials of an Enterprise admin whose enterprise role has the application integration privileges.
package_id	The document ID for which workflow user needs to be updated.
order	The order of the user in workflow for which the permissions are requested. By providing the value 0 in order, service would return the permissions of most recently added collaborator in the workflow.
Response Parameters
print	True, if printing is allowed for this recipient.
download	True, if download is allowed.
add_text	True, if add text annotation on the document is allowed.
add_attachment	True, if attachments and merging of PDF documents is allowed.
change_recipients	True, if the recipient on the current order can change other recipients in the workflow after workflow is shared.
legal_notice > enabled	True, if legal notice is enabled and configured for the recipient.
legal_notice > allowed_notices	List of legal notices allowed to the document owner from which he can select one for the recipient.
Legal_notice > allowed_notices > legal_notice_name	Name of the legal notice.
Legal_notice > allowed_notices >legal_notice_html	HTML content of the legal notice.
default_notice	Default or selected legal notice for the recipient.
Message	The service specific error message returned by the API. This message provides useful information about why the service has returned an error response.