Skip to main content
Version: 4.18.1

Initiate PDF Signature

Use this API, to sign the PDF documents and send back to the path provided in the request.

Resource Informations

Requires authentication?Yes
Rate limited?No


Request headers

AuthorizationBearer token

HTTP request URL for SSMS

POST https://{tenantId}.{hostname}/digitanium/v3/mpower/users/{userName}/signature

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/mpower/v1/users/{userName}/signature?sigantureFile={signaturefile}&sigantureData={signaturedata}

API requests must be made over https. Calls made over plain http will fail.


No parameter fields are required.

Request body

Field NameTypeDescription
* sigantureFileFileFile you wanted to sign
* sigantureDataJSONData required to initiate PDF sign

signatureData Detail

Field NameTypeDescription
* pageNumberFileFile you wanted to sign
* topRightXCoordinateIntegerRight side Top Y-axis value to start signature area
* topRightYCoordinateIntegerRight side Top Y-axis value to start signature area
* bottomLeftXCoordinateIntegerLeft side Bottom X-axis value to end signature area
* bottomLeftYCoordinateIntegerLeft side Bottom Y-axis value to end signature area
* serviceUuiduuidUUID of the service through which signature needs to be send.
* messageTextStringMessage to be displayed while sending document.
* callbackUrlURLURL which you want to receive pdf signature result (should be of POST method)
instanceIdStringSome string value. If not provided by default a Random ID will be assigned

Sample Request


"pageNumber": 1,
"bottomLeftXCoordinate": 60,
"bottomLeftYCoordinate": 60,
"topRightXCoordinate": 30,
"topRightYCoordinate": 30,
"serviceUuid": "4f584fde-e64d-4e1d-ac84-8b6f300ca088",
"instanceId": "45dadd43-ab43-4e1d-ac84-8b6f300ca088",
"messageText": "Please sign here",
"callbackUrl": "https://<HOST>/path"


A PDF File


Content-Disposition: form-data; name="signatureData"
Content-Type: application/json

"pageNumber": 1,
"bottomLeftXCoordinate": 60,
"bottomLeftYCoordinate": 10,
"topRightXCoordinate": 90,
"topRightYCoordinate": 20,
"serviceUuid": "28a5fab2-47c7-46c4-9d4e-2391a0c2c58e",
"instanceId": "c5b58568-9a6e-4948-a9f0-949811df39af",
"messageText": "Please sign here",
"callbackUrl": "https://<HOST>/path"
Content-Disposition: form-data; name="signatureFile"; filename="sample.pdf"
Content-Type: application/pdf

<PDF binary>


Field NameTypeDescription
instanceIdStringInstance ID corresponding to the signature request
processIdStringProcess ID which is used to fetch the signed document

Sample Response


Response Status Information

200OKFor successfull update
400statusBad request