Back

GET api/v1/ESign/{trackingId}/status

Requires Authorization

Get status for esign messages
Note: If tracking id is invalid or is not an esign type, no data will be returned

Request Information

URI Parameters

Name	Description	Type	Additional information
trackingId	message tracking key	string	Required

Body Parameters

None.

Sample Request

Response Information

Resource Description

ESignMessageStatusMessageViewModel

Name	Description	Type	Additional information
TrackingId	Message tracking Id	string	None.
SenderAddress	Sender Address	string	None.
Subject	Message subject	string	None.
DateSent	Message date	date	None.
ESignStatus	ESign status	string	None.
Recipients	Recipient details	Collection of ESignRecipientsViewModel	None.
HasMessageExpired	true if message is past its expiration date, false otherwise	boolean	None.
ExpiresInDays	Number of days left for message expiration	integer	None.
ESignType	Email Sign or HandSign	string	None.

Sample Response

application/json, text/json

Sample:

{
  "TrackingId": "E01D813EDD7BD411FCBB5CB8CD3F96DBD05C24D1",
  "SenderAddress": "sender@rpost.com",
  "Subject": "HandSign For Review",
  "DateSent": "2020-07-31T01:17:06",
  "ESignStatus": "Completed",
  "Recipients": [
    {
      "Address": "recipient@rpost.com",
      "AddressType": "To",
      "TimeSent": "2020-07-31T01:17:06",
      "ESignStatus": "ContractSigned",
      "TimeSigned": "2020-07-31T01:17:44",
      "LinkClickedTime": "2020-07-31T01:17:21",
      "TimeOpened": "2020-07-31T01:17:16"
    }
  ],
  "HasMessageExpired": false,
  "ExpiresInDays": 30,
  "ESignType": "HandSign"
}