Open Document via Password - SigningHub-APIGuide

Business applications can use this service API to submit a password from a particular recipient, specified by the order.

https://api.signinghub.com/v3/packages/{package_id}/workflow/{order}/authentication/password
HTTP Verb		POST
Content-Type		application/json
Accept		application/json
Authorization		Bearer {access_token}
Request Body		`{` `"password":` `"12345678"` `}`
Status Code	Message	Response Body
200	OK	`{` `"Message":` `"access to the document is granted"` `}`
401	Unauthorized	`{` `"Message":` `"Request authorization denied"` `}`
		`{` `"Message":` `"User authentication required"` `}`
403	Forbidden	`{` `"Message":` `"Document does not belong to user"` `}`
		`{` `"Message":` `"Account is disabled"` `}`
404	Not Found	`{` `"Message":` `"Document 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.
order	The order of the user for which the password is to be submitted.
package_id	The ID of the package for which the password is submitted.
password	String password for the document package for verification and opening the package.
Response Parameters
Message	The service specific error message returned by the API. This message provides useful information about why the service has returned an error response.