Open Document Package
Applications can call this API when a document package is opened by a recipient in the application. This API call will update the document reading status as well as create necessary logs.
|
https://api.signinghub.com/v3/packages/{package_id}/open |
||
|
HTTP Verb |
GET |
|
|
Content-Type |
application/json |
|
|
Accept |
application/json |
|
|
Authorization |
Bearer {access_token} |
|
| x-password |
"pincode123" |
|
| x-otp |
"123456" | |
|
Request Body |
|
|
|
Status Code |
Message |
Response Body |
|
200 |
OK |
|
|
401 |
Unauthorized |
{ "Message": "Request authorization denied"} |
{ "Message": "User authentication required"} |
||
|
403 |
Forbidden |
{ "Error": "invalid_credentials" "Message": "You have entered incorrect authentication credentials - try again"} |
{ "Error": "otp_required" "Message": "One time password is required"} |
||
{ "Error": "password_required" "Message": "Password authentication is required"} |
||
{ "Message": "Document does not belong to user"} |
||
{ "Message": "You cannot access this document before the access period starts"} |
||
{ "Message": "You cannot access this document after the access period ends"} |
||
{ "Message": "This document is no longer available for your review - your signature delegation rights have changed or expired"} |
||
{ "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. |
| x-password | Password of the document, if a document opening password was set by the document owner for the recipient. Otherwise null or ignore. |
| x-otp | OTP value for opening the document, if a document opening OTP permission was set by the document owner. Otherwise null or ignore. |
| 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. |