Home > API Reference > Document Processing > Approve Document

Approve Document

Business applications can use this service API to approve a document by a specified user in the order.

https://api.signinghub.com/v3/packages/{package_id}/approve

HTTP Verb

POST

Content-Type

application/json

Accept

application/json

Authorization

Bearer {access_token}

Request Body

{
   "reason": "I approve this document"
}

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": "You cannot access this document after the access period ends"
}
{
   "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.

 package_id The ID of the package to be approved.

 reason (optional) The reason for approving a 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.




See also
Signer Authentication via OTP (Users, In-persons, E-Signers)
Fill Initials
Fill Form Fields
Sign Document
Decline Document
Submit Document
Recall Document
Finish Processing
Get Registered Devices
Authorisation Signing Request Status