Add Digital Signature Field
https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/fields/digital_signature |
||
HTTP Verb |
POST |
|
Authorization |
Bearer {access_token} |
|
Content-Type |
application/json |
|
Accept |
application/json |
|
Response Headers |
||
Request Body |
{ "order" : 1, "page_no" : 1, "field_name" : "Digital Sign field" , "dimensions" : { "x" : 200, "y" : 200, "width" : 100, "height" : 100 }
|
|
Status Code |
Message |
Response Body |
200 |
OK |
{ "field_name" : "Digital Sign field" } |
403 | Forbidden |
{ "Message" : "You are not allowed to perform this action on locked workflow" } |
{ "Message" : "Account is disabled" }
|
||
{ "Message" : "You are not allowed to perform the requested operation" } |
||
{ "Message" : "You cannot add fields once the document is certified and signed" } |
||
{ "Message" : "You cannot add fields once the document is locked" } |
||
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. |
package_id |
The package ID for which workflow details need to be updated. |
document_id | The document ID where the field is to be added. |
order | Order of the recipient for which the field is being created. |
page_no | Page number at which the field is about to be created. |
field_name (optional) | Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field. |
display (optional) | Visibility of the field that is to be added, possible values are "VISIBLE" and "INVISIBLE" |
dimensions > x | Left location of the field in pixel. |
dimensions > y | Top location of the field in pixel. |
dimensions > width | Width of the field in pixel. |
dimensions > height | Height of the field in pixel. |
Response Parameters: | |
field_name | Name of the field created in the 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. |