Initiate PDF Signature

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

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	multipart/form-data

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}

note

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

Parameters

No parameter fields are required.

Request body

Field Name	Type	Description
sigantureFile (Required)	File	File you wanted to sign
sigantureData (Required)	JSON	Data required to initiate PDF sign

signatureData Detail

Field Name	Type	Description
pageNumber (Required)	File	File you wanted to sign
topRightXCoordinate (Required)	Integer	Right side Top Y-axis value to start signature area
topRightYCoordinate (Required)	Integer	Right side Top Y-axis value to start signature area
bottomLeftXCoordinate (Required)	Integer	Left side Bottom X-axis value to end signature area
bottomLeftYCoordinate (Required)	Integer	Left side Bottom Y-axis value to end signature area
serviceUuid (Required)	uuid	UUID of the service through which signature needs to be send.
messageText (Required)	String	Message to be displayed while sending document.
callbackUrl (Required)	URL	URL which you want to receive pdf signature result (should be of POST method)
instanceId (Required)	String	Some string value. If not provided by default a Random ID will be assigned

Sample Request

signatureData

{
    "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",
}

note

To use this API, you must provide a PDF file as the signatureFile in the request body.

Sample Response

--------------------------4732c647e9338d09
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"
}
--------------------------4732c647e9338d09
Content-Disposition: form-data; name="signatureFile"; filename="sample.pdf"
Content-Type: application/pdf

<PDF binary>
--------------------------4732c647e9338d09--

Response

Field Name	Type	Description
instanceId	String	Instance ID corresponding to the signature request
processId	String	Process ID which is used to fetch the signed document

Sample Response

{
    "processId":"process-0fabbc2b-33bc-4136-8b0a-asdads33232",
    "instanceId":"instance-sdfsd322-b47e-440a-9322-dsa332df342"
}

Response Status Information

Status	Type	Description
200	OK	For successfull update
400	status	Bad request
401	status	Unauthorized