Download Package
https://api.signinghub.com/v3/packages/{package_id} |
||
HTTP Verb |
GET |
|
Accept |
application/octet-stream |
|
Authorization |
Bearer {access_token} |
|
x-password |
"pincode123" |
|
x-otp |
"123456" |
|
Request Body |
|
|
Status Code |
Message |
Response Body |
200 |
OK |
file(bytes) |
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" : "Downloading document is not allowed in draft mode" } |
||
{ "Message" : "Account is disabled" } |
||
{ "Message" : "You are not allowed to perform the requested operation" } |
||
404 |
Not Found |
{ "Message" : "Document not found" } |
500 |
Internal Server Error |
{ "Message" : "An internal server error occurred while processing the request" } |
Item Details | |
Names |
Description |
Request Parameters |
|
access_token | The access token obtained as a result of successful authentication. If the "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 required to view the document if set by the owner for the recipient. |
x-otp | OTP required to view the document if set by the owner for the recipient. |
package_id |
The package ID to be downloaded. |
Response Parameters | |
file(binary) |
The document in binary form. |
Message | The service specific error message returned by the API. This message provides useful information about why the service has returned an error response. |