Fill Initials - SigningHub-APIGuide

Business applications can use this service API to fill an initials field in a document by a specified user in the order.

https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/initial
HTTP Verb		POST
Content-Type		application/json
Accept		application/json
Authorization		Bearer {access_token}
Request Body		`{` `"field_name":` `"SH_Field_Name",` `"image":` `"base64",` `"apply_to_all":` `true` `}`
Status Code	Message	Response Body
200	OK
401	Unauthorized	`{` `"Message":` `"Request authorization denied"` `}`
		`{` `"Message":` `"User authentication required"` `}`
403	Forbidden	`{` `"Message":` `"Document does not belong to user"` `}`
		`{` `"Message":` `"You cannot access this document after the access period ends"` `}`
		`{` `"Message":` `"Account is disabled"` `}`
		`{` `"Message":` `"Could not upload file - it is infected by malware"` `}`
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.
document_id	The ID of the document.
order	The order of the user in the workflow who is filling the initial.
field_name	Unique identifier of the field in the document.
image	Base64 image used for the filling of the initials.
apply_to_all (optional)	True if all initials are to be filled.
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.