Authorisation Signing Request Status
Applications can use this API to get the status of authorised signing request against provided signature field name.
|
https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/field/status |
||
|
HTTP Verb |
POST |
|
|
Authorization |
Bearer {access_token} |
|
|
Content-Type |
application/json |
|
|
Accept |
application/json |
|
|
Request Body |
{ "field_name": "signinghub_signature_field_name"
|
|
|
Status Code |
Message |
Response Body |
|
200 |
OK |
{ "status": "SIGNED"} |
| 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"} |
| 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. |
| field_name | Name of signature field. |
| Response Parameters | |
| status | Returns the current status of signature field. Possible values are SIGNED, PENDING, FAILED, DECLINED |
| Message | The service specific error message returned by the API. This message provides useful information about why the service has returned an error response. |