Add In-person Field
https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/fields/in_person_signature |
||
HTTP Verb |
POST |
|
Authorization |
Bearer {access_token} |
|
Content-Type |
application/json |
|
Accept |
application/json |
|
Response Headers |
||
Request Body |
{
"order" : 1, "page_no" : 1, "placeholder" : "Customer 1" , "dimensions" : { "x" : 200, "y" : 200, "width" : 100, "height" : 100 }, "authentication" : { "enabled" : true , "sms_otp" : { "enabled" : true , "mobile_no" : "+923339633409" } } }
|
|
Status Code |
Message |
Response Body |
200 |
OK |
{ "field_name" : "In-person field" } |
403 | Forbidden |
{
"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 |
{
"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. |
package_id | Package ID to which the document is added. |
document_id | The document ID for which the action is to be taken. |
order |
The order of the user in workflow for which the field is being added. |
page_no | Page number on which the field is 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" |
placeholder | String identifier for the inperson field, it can be Customer, Jack, CEO etc. |
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. |
authentication > enabled | True, if authentication is enabled for the field. |
authentication > sms_otp > enabled |
True, if SMS OTP authentication is enabled for the field. |
mobile_number |
Mobile number of the recipient to which the field is assigned. Supported formats are as follows +923339633409 00923339633409 923339633409 |
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. |