Get Certify Policy for a document
https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/certify |
||
HTTP Verb |
GET |
|
Authorization |
Bearer {access_token} |
|
Content-Type |
application/json |
|
Accept |
application/json |
|
Response Headers |
||
Request Body |
|
|
Status Code |
Message |
Response Body |
200 |
OK |
{ "certify" : { "enabled" : true , "allowed_permissions" : [ "NO_CHANGES_ALLOWED" , "FORM_FILLING_ALLOWED" , "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED" ], "default_permission" : "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED" }, "lock_form_fields" : true }
|
403 | Forbidden |
{ "Message" : "Account is disabled" } |
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. |
document_id |
The ID of the document to be downloaded. |
package_id | Package ID of the package to which the document is added. |
Response Parameters | |
certify | Certify signature settings for the document. |
certify > enabled | True if certify signature is enabled for the document. |
certify >allowed_permissions | Set of allowed certify permission levels for the document. |
certify > default_permission | Selected permission level for the certify signature settings. |
lock_form_fields | True if forms fields are to be locked in the PDF after the last digital signature on the current document. |
Message |
The service specific error message returned by the API. This message provides useful information about why the service has returned an error response. |