Finish Processing
Business applications can use this service API to finish the document processing after signing all the signature fields. This method is primarily used by native SigningHub mobile apps for iOS and Android, and mobile web use cases. General business applications employing tight integration into their respective portal do not need to call this method. However, when using the Sign Document API (and hence the user is not presented with a visual representation of the document they are requested to sign) calling this API is required in order to ensure the respective workflow continues or completes. For example, once all signatures have been applied using the "blind" Sign Document API call the document will not show as status "Completed" to the owner until this API is invoked. The document owner will see a status of "In Progress" until this API is called.
Within native SigningHub mobile apps and mobile web use cases, this call is necessary to ensure that each user completes their respective actions with respect to SigningHub. For example, after a signatory has signed a document in SigningHub App, this method is invoked by the application to ensure the workflow continues to process and the next signatory is notified, and the document status is available via the configured call-back URL.
|
https://api.signinghub.com/v3/packages/{package_id}/finish |
||
|
HTTP Verb |
POST |
|
|
Accept |
application/json |
|
| Content-Type | application/json | |
| Authorization | Bearer {access_token} |
|
|
Request Body |
||
|
Status Code |
Message |
Response Body |
|
200 |
OK |
|
| 403 | Forbidden |
{ "Message": "You cannot access this document after the access period ends"} |
{ "Message": "Account is disabled"} |
||
|
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 finished. |
| 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. |