RMail API

Back to Manage

GET api/V1/Manage/GetDownloadedTransparencyDocument/{envelopeCodeOrEnvelopeId}

This method is used to retrieve the envelope details by code.

Prerequisites

lorem ipsum

Steps to follow-:

1. Initialize Envelope – using following url

2. Upload Local Document – using following url

3. Delete Document [Optional] – using following url

4. Prepare Envelope – using following url

5. Add Signature Control [Optional] – using following url

6. Delete Control [Optional] – using following url

7. Clear Controls [Optional] – using following url

8. Send Envelope – using following url

Request Information

Lorem ipsum

URI Parameters

Name Description Type ADDITIONAL INFORMATION
envelopeCodeOrEnvelopeId This is an Envelope Code. string Required

Header Parameters

Header Description

Name Description Type
Content-Type This is a request content type application/json
Accept This is a response content type application/json
AuthToken This is user’s authorization token. example@example.com^296f1f85-35d4-4dd4-a350-67131c926546^rps^en-US

Note: From the Header parameters mentioned, “AuthToken” is not required for the below mentioned services.

  • Account/RegisterUser
  • Authentication/AuthenticateUser

Body Parameters

None

Response Information

Resource Description

Name Description Type ADDITIONAL INFORMATION
EnvelopeCode This will return Envelope Code.

string None
IsSequential This will return Envelope’s Subject.

boolean None
EnvelopeCodeDisplay This will return Is sequential.

string None
Subject This will return Envelope’s Subject.

string None
CurrentStatus This will return Envelope’s Current Status.

string None
Sent This will return Envelope’s Sent details.

string None
Completed This will return Envelope’s Completed details.

string None
DocumentList This will return Document details.

Collection of DocumentDetails None
Sender This will return sender information.

string None
DelegatedTo This will return delegated recipient information.

string None
EnvelopeStatusDescription This will return Envelope’s Status .

string None
DocumentHistory This will return Document’s history.

Collection of DocumentStatus None
CompletedStatusDate This will return completed status details.

string None
PasswordReqdToOpen boolean None
PasswordReqdToSign
This will return flag for password required to sign the envelope.

boolean None
PasswordToOpen This will return password to open the signed document.

string None
PasswordToSign This will return password to sign the envelope.

string None
RecipientNameList This will return password to sign the envelope.

string None
recipientIdForWaitingForSignature globally unique identifier
None
StatusId This will return Status ID.

globally unique identifier
None
EnvelopeId This will return envelope ID.

GUID None
ExpiryDate This will return envelope ID.

date None
IsFinalDocLinkReq This will return bool for final link

boolean
None
IsTransparencyDocReq This will return bool for final link

boolean
None
UserID This will return bool for final link

globally unique identifier
None
senderEmail This will return email of sender.

string None
IPAddressSender This will return order

string None
IsDiclaimerAccepted Get/Set if signer accepts disclaimer

boolean None
IsFinalContractDeleleted Get/Set if Final Contract Deleted

boolean None
RecipientsDetail Get/Set Recipients Detail

Collection of RecipientsDetailsAPI None
IsZipExist This will return if Signer has attached any documents at time of signing

boolean None
ZipPath This will return file path of zip folder of signer attachments

string
None
IsEnvelopeStatic This will return if envelope is created from static template or not

boolean None
AccessAuthenticationCode This will return Access authentication type for envelope

globally unique identifier
None
EnvelopeEmailBody This will return Email Body for envelope

string None
IsEmailBodyDisplay This will return if user removed email body from manage tab

boolean None
DicLabelText This will return Key and value for Multilingual

Dictionary of globally unique identifier [key] and string [value]
None
IsEnvelopeEditableAfterSend This will return if sender can update envelope after sent

boolean None
IsEnvelopeUpdated This will return if sender has updated envelope after sent

boolean None
IsEnvelopeEdited boolean None
SenderCompanyID Get Company ID of Sender

globally unique identifier
None
SenderAPISettings Settings of Sender

AdminGeneralAndSystemSettings None

Response Formats

application/json, text/json, application/xml, text/xml
Sample:
{
"EnvelopeCode": "sample string 1",
"IsSequential": true,
"EnvelopeCodeDisplay": "sample string 3",
"Subject": "sample string 4",
"CurrentStatus": "sample string 5",
"Sent": "sample string 6",
"Completed": "sample string 7",
"DocumentList": [
{
  "ID": "2c35dd20-42b9-42c0-b236-a1fbfd2e307e",
  "DocumentName": "sample string 2",
  "EnvelopeID": "247b3e13-3d84-4c19-b1c6-5599eaa3c928",
  "Order": 1,
  "UploadedDateTime": "2020-06-05T08:23:40.9211742+00:00",
  "FileSize": "sample string 5",
  "documentContentDetails": [
    {
      "ControlHtmlData": "sample string 1",
      "ControlHtmlID": "sample string 2",
      "ControlID": "c788ff9d-af0e-4f76-ad5a-a79b43792e44",
      "DocumentID": "2cb243f4-c419-44d9-a11a-2d74bd99448f",
      "GroupName": "sample string 5",
      "Height": 1,
      "ID": "99937d01-7acf-4784-91f2-dd5203a301eb",
      "Label": "sample string 7",
      "PageNo": 1,
      "DocumentPageNo": 1,
      "RecipientID": "ac630c97-a60b-47e1-b382-b891f6ea84b3",
      "MappedTemplateControlID": "ca0e84c0-b268-4a33-b59e-e015549b6e50",
      "Required": true,
      "SenderControlValue": "sample string 9",
      "Width": 1,
      "XCoordinate": 1,
      "YCoordinate": 1,
      "ZCoordinate": 1,
      "ControlValue": "sample string 10",
      "RecipientName": "sample string 11",
      "MaxLength": "sample string 12",
      "TextType": "sample string 13",
      "controlStyleDetails": [
        {
          "FontID": "5ff09499-d912-4d12-9f55-2e92f9a5ec6c",
          "FontName": "sample string 2",
          "FontSize": 64,
          "FontColor": "sample string 4",
          "IsBold": true,
          "IsItalic": true,
          "IsUnderline": true
        },
        {
          "FontID": "5ff09499-d912-4d12-9f55-2e92f9a5ec6c",
          "FontName": "sample string 2",
          "FontSize": 64,
          "FontColor": "sample string 4",
          "IsBold": true,
          "IsItalic": true,
          "IsUnderline": true
        }
      ],
      "ControlStyle": {
        "FontID": "5ff09499-d912-4d12-9f55-2e92f9a5ec6c",
        "FontName": "sample string 2",
        "FontSize": 64,
        "FontColor": "sample string 4",
        "IsBold": true,
        "IsItalic": true,
        "IsUnderline": true
      },
      "SelectControlOptions": [
        {
          "DocumentContentID": "6cdc7b42-a587-408e-8b6a-a66f9585a8be",
          "ID": "a56759ab-fe75-4b8c-ad12-2ca15f7dc9fb",
          "OptionText": "sample string 3",
          "Order": 4
        },
        {
          "DocumentContentID": "6cdc7b42-a587-408e-8b6a-a66f9585a8be",
          "ID": "a56759ab-fe75-4b8c-ad12-2ca15f7dc9fb",
          "OptionText": "sample string 3",
          "Order": 4
        }
      ],
      "DependentFields": [
        {
          "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
          "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
          "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
          "SupportText": "sample string 3",
          "GroupCode": 1.0,
          "IsRequired": true
        },
        {
          "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
          "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
          "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
          "SupportText": "sample string 3",
          "GroupCode": 1.0,
          "IsRequired": true
        }
      ],
      "LeftIndex": 1.1,
      "TopIndex": 1.1,
      "ConditionalControlsDetails": {
        "ID": "d1951f8a-cefd-4d87-836b-8af44ebbfe5d",
        "EnvelopeID": "e09ac90b-78d0-4f68-b100-2720a67be782",
        "ControlID": "4f9f87d6-67e7-4437-b545-62960a3e92cc",
        "ControllingFieldID": "9b95a7a1-89a7-4509-aff5-d9f2a701c767",
        "ControllingConditionID": "05b1bccc-85fe-4ef9-a915-c6e84c025683",
        "ControllingSupportText": "sample string 4",
        "EnvelopeStage": "sample string 5",
        "DependentFields": [
          {
            "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
            "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
            "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
            "SupportText": "sample string 3",
            "GroupCode": 1.0,
            "IsRequired": true
          },
          {
            "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
            "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
            "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
            "SupportText": "sample string 3",
            "GroupCode": 1.0,
            "IsRequired": true
          }
        ],
        "GroupCode": 1.0,
        "IsRequired": "sample string 6"
      }
    },
    {
      "ControlHtmlData": "sample string 1",
      "ControlHtmlID": "sample string 2",
      "ControlID": "c788ff9d-af0e-4f76-ad5a-a79b43792e44",
      "DocumentID": "2cb243f4-c419-44d9-a11a-2d74bd99448f",
      "GroupName": "sample string 5",
      "Height": 1,
      "ID": "99937d01-7acf-4784-91f2-dd5203a301eb",
      "Label": "sample string 7",
      "PageNo": 1,
      "DocumentPageNo": 1,
      "RecipientID": "ac630c97-a60b-47e1-b382-b891f6ea84b3",
      "MappedTemplateControlID": "ca0e84c0-b268-4a33-b59e-e015549b6e50",
      "Required": true,
      "SenderControlValue": "sample string 9",
      "Width": 1,
      "XCoordinate": 1,
      "YCoordinate": 1,
      "ZCoordinate": 1,
      "ControlValue": "sample string 10",
      "RecipientName": "sample string 11",
      "MaxLength": "sample string 12",
      "TextType": "sample string 13",
      "controlStyleDetails": [
        {
          "FontID": "5ff09499-d912-4d12-9f55-2e92f9a5ec6c",
          "FontName": "sample string 2",
          "FontSize": 64,
          "FontColor": "sample string 4",
          "IsBold": true,
          "IsItalic": true,
          "IsUnderline": true
        },
        {
          "FontID": "5ff09499-d912-4d12-9f55-2e92f9a5ec6c",
          "FontName": "sample string 2",
          "FontSize": 64,
          "FontColor": "sample string 4",
          "IsBold": true,
          "IsItalic": true,
          "IsUnderline": true
        }
      ],
      "ControlStyle": {
        "FontID": "5ff09499-d912-4d12-9f55-2e92f9a5ec6c",
        "FontName": "sample string 2",
        "FontSize": 64,
        "FontColor": "sample string 4",
        "IsBold": true,
        "IsItalic": true,
        "IsUnderline": true
      },
      "SelectControlOptions": [
        {
          "DocumentContentID": "6cdc7b42-a587-408e-8b6a-a66f9585a8be",
          "ID": "a56759ab-fe75-4b8c-ad12-2ca15f7dc9fb",
          "OptionText": "sample string 3",
          "Order": 4
        },
        {
          "DocumentContentID": "6cdc7b42-a587-408e-8b6a-a66f9585a8be",
          "ID": "a56759ab-fe75-4b8c-ad12-2ca15f7dc9fb",
          "OptionText": "sample string 3",
          "Order": 4
        }
      ],
      "DependentFields": [
        {
          "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
          "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
          "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
          "SupportText": "sample string 3",
          "GroupCode": 1.0,
          "IsRequired": true
        },
        {
          "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
          "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
          "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
          "SupportText": "sample string 3",
          "GroupCode": 1.0,
          "IsRequired": true
        }
      ],
      "LeftIndex": 1.1,
      "TopIndex": 1.1,
      "ConditionalControlsDetails": {
        "ID": "d1951f8a-cefd-4d87-836b-8af44ebbfe5d",
        "EnvelopeID": "e09ac90b-78d0-4f68-b100-2720a67be782",
        "ControlID": "4f9f87d6-67e7-4437-b545-62960a3e92cc",
        "ControllingFieldID": "9b95a7a1-89a7-4509-aff5-d9f2a701c767",
        "ControllingConditionID": "05b1bccc-85fe-4ef9-a915-c6e84c025683",
        "ControllingSupportText": "sample string 4",
        "EnvelopeStage": "sample string 5",
        "DependentFields": [
          {
            "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
            "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
            "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
            "SupportText": "sample string 3",
            "GroupCode": 1.0,
            "IsRequired": true
          },
          {
            "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
            "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
            "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
            "SupportText": "sample string 3",
            "GroupCode": 1.0,
            "IsRequired": true
          }
        ],
        "GroupCode": 1.0,
        "IsRequired": "sample string 6"
      }
    }
  ]
},
{
  "ID": "2c35dd20-42b9-42c0-b236-a1fbfd2e307e",
  "DocumentName": "sample string 2",
  "EnvelopeID": "247b3e13-3d84-4c19-b1c6-5599eaa3c928",
  "Order": 1,
  "UploadedDateTime": "2020-06-05T08:23:40.9211742+00:00",
  "FileSize": "sample string 5",
  "documentContentDetails": [
    {
      "ControlHtmlData": "sample string 1",
      "ControlHtmlID": "sample string 2",
      "ControlID": "c788ff9d-af0e-4f76-ad5a-a79b43792e44",
      "DocumentID": "2cb243f4-c419-44d9-a11a-2d74bd99448f",
      "GroupName": "sample string 5",
      "Height": 1,
      "ID": "99937d01-7acf-4784-91f2-dd5203a301eb",
      "Label": "sample string 7",
      "PageNo": 1,
      "DocumentPageNo": 1,
      "RecipientID": "ac630c97-a60b-47e1-b382-b891f6ea84b3",
      "MappedTemplateControlID": "ca0e84c0-b268-4a33-b59e-e015549b6e50",
      "Required": true,
      "SenderControlValue": "sample string 9",
      "Width": 1,
      "XCoordinate": 1,
      "YCoordinate": 1,
      "ZCoordinate": 1,
      "ControlValue": "sample string 10",
      "RecipientName": "sample string 11",
      "MaxLength": "sample string 12",
      "TextType": "sample string 13",
      "controlStyleDetails": [
        {
          "FontID": "5ff09499-d912-4d12-9f55-2e92f9a5ec6c",
          "FontName": "sample string 2",
          "FontSize": 64,
          "FontColor": "sample string 4",
          "IsBold": true,
          "IsItalic": true,
          "IsUnderline": true
        },
        {
          "FontID": "5ff09499-d912-4d12-9f55-2e92f9a5ec6c",
          "FontName": "sample string 2",
          "FontSize": 64,
          "FontColor": "sample string 4",
          "IsBold": true,
          "IsItalic": true,
          "IsUnderline": true
        }
      ],
      "ControlStyle": {
        "FontID": "5ff09499-d912-4d12-9f55-2e92f9a5ec6c",
        "FontName": "sample string 2",
        "FontSize": 64,
        "FontColor": "sample string 4",
        "IsBold": true,
        "IsItalic": true,
        "IsUnderline": true
      },
      "SelectControlOptions": [
        {
          "DocumentContentID": "6cdc7b42-a587-408e-8b6a-a66f9585a8be",
          "ID": "a56759ab-fe75-4b8c-ad12-2ca15f7dc9fb",
          "OptionText": "sample string 3",
          "Order": 4
        },
        {
          "DocumentContentID": "6cdc7b42-a587-408e-8b6a-a66f9585a8be",
          "ID": "a56759ab-fe75-4b8c-ad12-2ca15f7dc9fb",
          "OptionText": "sample string 3",
          "Order": 4
        }
      ],
      "DependentFields": [
        {
          "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
          "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
          "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
          "SupportText": "sample string 3",
          "GroupCode": 1.0,
          "IsRequired": true
        },
        {
          "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
          "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
          "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
          "SupportText": "sample string 3",
          "GroupCode": 1.0,
          "IsRequired": true
        }
      ],
      "LeftIndex": 1.1,
      "TopIndex": 1.1,
      "ConditionalControlsDetails": {
        "ID": "d1951f8a-cefd-4d87-836b-8af44ebbfe5d",
        "EnvelopeID": "e09ac90b-78d0-4f68-b100-2720a67be782",
        "ControlID": "4f9f87d6-67e7-4437-b545-62960a3e92cc",
        "ControllingFieldID": "9b95a7a1-89a7-4509-aff5-d9f2a701c767",
        "ControllingConditionID": "05b1bccc-85fe-4ef9-a915-c6e84c025683",
        "ControllingSupportText": "sample string 4",
        "EnvelopeStage": "sample string 5",
        "DependentFields": [
          {
            "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
            "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
            "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
            "SupportText": "sample string 3",
            "GroupCode": 1.0,
            "IsRequired": true
          },
          {
            "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
            "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
            "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
            "SupportText": "sample string 3",
            "GroupCode": 1.0,
            "IsRequired": true
          }
        ],
        "GroupCode": 1.0,
        "IsRequired": "sample string 6"
      }
    },
    {
      "ControlHtmlData": "sample string 1",
      "ControlHtmlID": "sample string 2",
      "ControlID": "c788ff9d-af0e-4f76-ad5a-a79b43792e44",
      "DocumentID": "2cb243f4-c419-44d9-a11a-2d74bd99448f",
      "GroupName": "sample string 5",
      "Height": 1,
      "ID": "99937d01-7acf-4784-91f2-dd5203a301eb",
      "Label": "sample string 7",
      "PageNo": 1,
      "DocumentPageNo": 1,
      "RecipientID": "ac630c97-a60b-47e1-b382-b891f6ea84b3",
      "MappedTemplateControlID": "ca0e84c0-b268-4a33-b59e-e015549b6e50",
      "Required": true,
      "SenderControlValue": "sample string 9",
      "Width": 1,
      "XCoordinate": 1,
      "YCoordinate": 1,
      "ZCoordinate": 1,
      "ControlValue": "sample string 10",
      "RecipientName": "sample string 11",
      "MaxLength": "sample string 12",
      "TextType": "sample string 13",
      "controlStyleDetails": [
        {
          "FontID": "5ff09499-d912-4d12-9f55-2e92f9a5ec6c",
          "FontName": "sample string 2",
          "FontSize": 64,
          "FontColor": "sample string 4",
          "IsBold": true,
          "IsItalic": true,
          "IsUnderline": true
        },
        {
          "FontID": "5ff09499-d912-4d12-9f55-2e92f9a5ec6c",
          "FontName": "sample string 2",
          "FontSize": 64,
          "FontColor": "sample string 4",
          "IsBold": true,
          "IsItalic": true,
          "IsUnderline": true
        }
      ],
      "ControlStyle": {
        "FontID": "5ff09499-d912-4d12-9f55-2e92f9a5ec6c",
        "FontName": "sample string 2",
        "FontSize": 64,
        "FontColor": "sample string 4",
        "IsBold": true,
        "IsItalic": true,
        "IsUnderline": true
      },
      "SelectControlOptions": [
        {
          "DocumentContentID": "6cdc7b42-a587-408e-8b6a-a66f9585a8be",
          "ID": "a56759ab-fe75-4b8c-ad12-2ca15f7dc9fb",
          "OptionText": "sample string 3",
          "Order": 4
        },
        {
          "DocumentContentID": "6cdc7b42-a587-408e-8b6a-a66f9585a8be",
          "ID": "a56759ab-fe75-4b8c-ad12-2ca15f7dc9fb",
          "OptionText": "sample string 3",
          "Order": 4
        }
      ],
      "DependentFields": [
        {
          "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
          "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
          "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
          "SupportText": "sample string 3",
          "GroupCode": 1.0,
          "IsRequired": true
        },
        {
          "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
          "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
          "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
          "SupportText": "sample string 3",
          "GroupCode": 1.0,
          "IsRequired": true
        }
      ],
      "LeftIndex": 1.1,
      "TopIndex": 1.1,
      "ConditionalControlsDetails": {
        "ID": "d1951f8a-cefd-4d87-836b-8af44ebbfe5d",
        "EnvelopeID": "e09ac90b-78d0-4f68-b100-2720a67be782",
        "ControlID": "4f9f87d6-67e7-4437-b545-62960a3e92cc",
        "ControllingFieldID": "9b95a7a1-89a7-4509-aff5-d9f2a701c767",
        "ControllingConditionID": "05b1bccc-85fe-4ef9-a915-c6e84c025683",
        "ControllingSupportText": "sample string 4",
        "EnvelopeStage": "sample string 5",
        "DependentFields": [
          {
            "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
            "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
            "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
            "SupportText": "sample string 3",
            "GroupCode": 1.0,
            "IsRequired": true
          },
          {
            "ID": "f0e1a994-a88c-4e23-8ed9-195565aaa7a5",
            "ControlID": "63f3bc3f-d5c9-40c6-ad47-6b2eb25785a2",
            "ConditionID": "69a3d7fa-afc5-4645-88f6-9a491d14d24e",
            "SupportText": "sample string 3",
            "GroupCode": 1.0,
            "IsRequired": true
          }
        ],
        "GroupCode": 1.0,
        "IsRequired": "sample string 6"
      }
    }
  ]
}
],
"Sender": "sample string 8",
"DelegatedTo": "sample string 9",
"EnvelopeStatusDescription": "sample string 10",
"DocumentHistory": [
{
  "StatusDate": "sample string 1",
  "StatusID": "c30ff4bd-4124-4cd6-a419-5eac191e76b4",
  "SignerStatusDescription": "sample string 3",
  "Recipient": "sample string 4",
  "RecipientEmailAddress": "sample string 5",
  "IPAddress": "sample string 6",
  "RecipientTypeID": "d32e3edd-c7d1-4a8d-89f0-b9d6e3eed727",
  "RecipientId": "cdf7d420-19ea-4e09-8a53-fcd685db9d1e",
  "DelegatedTo": "sample string 9",
  "RecipientHistory": [
    {
      "ID": "86b9f3d6-a140-4ace-ac63-85f94d771a61",
      "IPAddress": "sample string 2",
      "RecipientID": "19736e32-35bc-466b-8995-01b10e63221e",
      "SignerStatusDescription": "sample string 4",
      "StatusDateTime": "sample string 5",
      "RecipientTypeID": "fb51c428-51dc-4075-8d54-a3b4a8d87916",
      "StatusTypeID": "6884f61a-df32-404b-9a12-36dcdf311415",
      "OldRecipient": "sample string 8",
      "OldEmail": "sample string 9",
      "CurrentRecipient": "sample string 10",
      "CurrentEmail": "sample string 11",
      "UpdatedBy": "sample string 12",
      "CreatedDateTime": "2020-06-05T08:23:40.9369248+00:00",
      "Description": "sample string 14",
      "DelegateTo": "sample string 15",
      "DelegateFrom": "sample string 16",
      "Name": "sample string 17",
      "EmailAddress": "sample string 18",
      "DelegateToEmail": "sample string 19",
      "DelegateFromEmail": "sample string 20",
      "ActiveRecipients": true,
      "RSignAnonymousToken": "sample string 22",
      "DeclineReasonID": 1
    },
    {
      "ID": "86b9f3d6-a140-4ace-ac63-85f94d771a61",
      "IPAddress": "sample string 2",
      "RecipientID": "19736e32-35bc-466b-8995-01b10e63221e",
      "SignerStatusDescription": "sample string 4",
      "StatusDateTime": "sample string 5",
      "RecipientTypeID": "fb51c428-51dc-4075-8d54-a3b4a8d87916",
      "StatusTypeID": "6884f61a-df32-404b-9a12-36dcdf311415",
      "OldRecipient": "sample string 8",
      "OldEmail": "sample string 9",
      "CurrentRecipient": "sample string 10",
      "CurrentEmail": "sample string 11",
      "UpdatedBy": "sample string 12",
      "CreatedDateTime": "2020-06-05T08:23:40.9369248+00:00",
      "Description": "sample string 14",
      "DelegateTo": "sample string 15",
      "DelegateFrom": "sample string 16",
      "Name": "sample string 17",
      "EmailAddress": "sample string 18",
      "DelegateToEmail": "sample string 19",
      "DelegateFromEmail": "sample string 20",
      "ActiveRecipients": true,
      "RSignAnonymousToken": "sample string 22",
      "DeclineReasonID": 1
    }
  ],
  "senderName": "sample string 10",
  "Order": 1
},
{
  "StatusDate": "sample string 1",
  "StatusID": "c30ff4bd-4124-4cd6-a419-5eac191e76b4",
  "SignerStatusDescription": "sample string 3",
  "Recipient": "sample string 4",
  "RecipientEmailAddress": "sample string 5",
  "IPAddress": "sample string 6",
  "RecipientTypeID": "d32e3edd-c7d1-4a8d-89f0-b9d6e3eed727",
  "RecipientId": "cdf7d420-19ea-4e09-8a53-fcd685db9d1e",
  "DelegatedTo": "sample string 9",
  "RecipientHistory": [
    {
      "ID": "86b9f3d6-a140-4ace-ac63-85f94d771a61",
      "IPAddress": "sample string 2",
      "RecipientID": "19736e32-35bc-466b-8995-01b10e63221e",
      "SignerStatusDescription": "sample string 4",
      "StatusDateTime": "sample string 5",
      "RecipientTypeID": "fb51c428-51dc-4075-8d54-a3b4a8d87916",
      "StatusTypeID": "6884f61a-df32-404b-9a12-36dcdf311415",
      "OldRecipient": "sample string 8",
      "OldEmail": "sample string 9",
      "CurrentRecipient": "sample string 10",
      "CurrentEmail": "sample string 11",
      "UpdatedBy": "sample string 12",
      "CreatedDateTime": "2020-06-05T08:23:40.9369248+00:00",
      "Description": "sample string 14",
      "DelegateTo": "sample string 15",
      "DelegateFrom": "sample string 16",
      "Name": "sample string 17",
      "EmailAddress": "sample string 18",
      "DelegateToEmail": "sample string 19",
      "DelegateFromEmail": "sample string 20",
      "ActiveRecipients": true,
      "RSignAnonymousToken": "sample string 22",
      "DeclineReasonID": 1
    },
    {
      "ID": "86b9f3d6-a140-4ace-ac63-85f94d771a61",
      "IPAddress": "sample string 2",
      "RecipientID": "19736e32-35bc-466b-8995-01b10e63221e",
      "SignerStatusDescription": "sample string 4",
      "StatusDateTime": "sample string 5",
      "RecipientTypeID": "fb51c428-51dc-4075-8d54-a3b4a8d87916",
      "StatusTypeID": "6884f61a-df32-404b-9a12-36dcdf311415",
      "OldRecipient": "sample string 8",
      "OldEmail": "sample string 9",
      "CurrentRecipient": "sample string 10",
      "CurrentEmail": "sample string 11",
      "UpdatedBy": "sample string 12",
      "CreatedDateTime": "2020-06-05T08:23:40.9369248+00:00",
      "Description": "sample string 14",
      "DelegateTo": "sample string 15",
      "DelegateFrom": "sample string 16",
      "Name": "sample string 17",
      "EmailAddress": "sample string 18",
      "DelegateToEmail": "sample string 19",
      "DelegateFromEmail": "sample string 20",
      "ActiveRecipients": true,
      "RSignAnonymousToken": "sample string 22",
      "DeclineReasonID": 1
    }
  ],
  "senderName": "sample string 10",
  "Order": 1
}
],
"CompletedStatusDate": "sample string 11",
"PasswordReqdToOpen": true,
"PasswordReqdToSign": true,
"PasswordToOpen": "sample string 14",
"PasswordToSign": "sample string 15",
"RecipientNameList": "sample string 16",
"recipientIdForWaitingForSignature": "5f386de9-3fc6-48a1-9bbf-132e330eb0bf",
"StatusId": "75cffe42-b467-4b8e-8b11-bb68ac722c31",
"EnvelopeId": "5c01b937-4ee3-4050-b49e-6cfde196d62b",
"ExpiryDate": "2020-06-05T08:23:40.9369248+00:00",
"IsFinalDocLinkReq": true,
"IsTransparencyDocReq": true,
"UserID": "9a560e4c-20da-492a-93b0-7aaf4a86b5e6",
"senderEmail": "sample string 22",
"IPAddressSender": "sample string 23",
"IsDiclaimerAccepted": true,
"IsFinalContractDeleleted": true,
"RecipientsDetail": [
{
  "ID": "86b9f3d6-a140-4ace-ac63-85f94d771a61",
  "IPAddress": "sample string 2",
  "RecipientID": "19736e32-35bc-466b-8995-01b10e63221e",
  "SignerStatusDescription": "sample string 4",
  "StatusDateTime": "sample string 5",
  "RecipientTypeID": "fb51c428-51dc-4075-8d54-a3b4a8d87916",
  "StatusTypeID": "6884f61a-df32-404b-9a12-36dcdf311415",
  "OldRecipient": "sample string 8",
  "OldEmail": "sample string 9",
  "CurrentRecipient": "sample string 10",
  "CurrentEmail": "sample string 11",
  "UpdatedBy": "sample string 12",
  "CreatedDateTime": "2020-06-05T08:23:40.9369248+00:00",
  "Description": "sample string 14",
  "DelegateTo": "sample string 15",
  "DelegateFrom": "sample string 16",
  "Name": "sample string 17",
  "EmailAddress": "sample string 18",
  "DelegateToEmail": "sample string 19",
  "DelegateFromEmail": "sample string 20",
  "ActiveRecipients": true,
  "RSignAnonymousToken": "sample string 22",
  "DeclineReasonID": 1
},
{
  "ID": "86b9f3d6-a140-4ace-ac63-85f94d771a61",
  "IPAddress": "sample string 2",
  "RecipientID": "19736e32-35bc-466b-8995-01b10e63221e",
  "SignerStatusDescription": "sample string 4",
  "StatusDateTime": "sample string 5",
  "RecipientTypeID": "fb51c428-51dc-4075-8d54-a3b4a8d87916",
  "StatusTypeID": "6884f61a-df32-404b-9a12-36dcdf311415",
  "OldRecipient": "sample string 8",
  "OldEmail": "sample string 9",
  "CurrentRecipient": "sample string 10",
  "CurrentEmail": "sample string 11",
  "UpdatedBy": "sample string 12",
  "CreatedDateTime": "2020-06-05T08:23:40.9369248+00:00",
  "Description": "sample string 14",
  "DelegateTo": "sample string 15",
  "DelegateFrom": "sample string 16",
  "Name": "sample string 17",
  "EmailAddress": "sample string 18",
  "DelegateToEmail": "sample string 19",
  "DelegateFromEmail": "sample string 20",
  "ActiveRecipients": true,
  "RSignAnonymousToken": "sample string 22",
  "DeclineReasonID": 1
}
],
"IsZipExist": true,
"ZipPath": "sample string 27",
"IsEnvelopeStatic": true,
"AccessAuthenticationCode": "428bd8cd-6cf7-4752-b0fa-27fadfcf3a93",
"EnvelopeEmailBody": "sample string 30",
"IsEmailBodyDisplay": true,
"DicLabelText": {
"427092c7-e14b-4078-a7b3-8f751057dd3c": "sample string 1",
"f92863df-91ad-4562-891b-3c073deb999a": "sample string 2"
},
"IsEnvelopeEditableAfterSend": true,
"IsEnvelopeUpdated": true,
"IsEnvelopeEdited": true,
"SenderCompanyID": "d8762cdd-b88a-4788-9db2-125d24385b5b",
"SenderAPISettings": {
"ID": "8e424833-165b-4e6f-af0f-fde11fe5335b",
"UserID": "949006b0-1e33-49c0-bd18-405c40dd76d4",
"CompanyID": "ec3054b4-e068-4356-b2a7-b08020f0153f",
"IsCompanySearchActive": true,
"ShowSettingsTabSelected": "c6525336-694e-4740-b2cb-8c2e271e107a",
"ShowSettingsTabDropdown": [
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  },
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  }
],
"OverrideUserSettings": true,
"DateFormatDisplayOptionSelected": 4,
"DateFormatID": "768d9781-a7a1-45f8-8ff5-b7f773c68cb3",
"DateFormats": [
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  },
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  }
],
"ExpiresInDisplayOptionSelected": 6,
"ExpiresInID": "bf60bfd9-b1f9-4a7a-a210-1356801cbeeb",
"ExpiresIn": [
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  },
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  }
],
"SendReminderInDisplayOptionSelected": 8,
"SendReminderIn": 9,
"SendReminderInDropdownSelected": "92c9309b-9b08-4da9-a3b7-cf394dbbbe5c",
"ThenSendReminderInDisplayOptionSelected": 11,
"ThenSendReminderIn": 12,
"ThenSendReminderInDropdownSelected": "fef73555-8cae-4105-9547-1d3dbca0ba85",
"RemindersDropdown": [
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  },
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  }
],
"IncludeSignedCertificateOnSignedPDFDisplayOptionSelected": 14,
"IncludeSignedCertificateOnSignedPDF": true,
"SignInSequenceDisplayOptionSelected": 16,
"SignInSequence": true,
"StoredSignedPDFDisplayOptionSelected": 18,
"StoredSignedPDF": true,
"IncludeTransparencyDocDisplayOptionSelected": 20,
"IncludeTransparencyDoc": true,
"StorageDriveLocal": true,
"StorageDriveGoogle": true,
"StorageDriveDropbox": true,
"StorageDriveSkydrive": true,
"SignatureCaptureType": true,
"SignatureCaptureHanddrawn": true,
"IsTimeZoneUTC": true,
"SelectedTimeZone": "sample string 29",
"TimeZone": [
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  },
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  }
],
"IsDisclaimerEnabled": true,
"Disclaimer": "sample string 31",
"EmailDisclaimer": "sample string 32",
"IsDeleteSignedContracts": true,
"IsCreateRules": true,
"IsIncludeSignerAttachFileDisplayOptionSelected": 35,
"IncludeSignerAttachFile": true,
"IsFormFieldAlignmentEnabled": true,
"IncludeCreateStaticLink": true,
"CreateStaticLinkDisplayOptionSelected": 39,
"IncludeAddXMLData": true,
"IsAddXMLDataDisplayOptionSelected": 41,
"SeparateMultipleDocumentsAfterSigningDisplayOptionSelected": 42,
"SeparateMultipleDocumentsAfterSigning": true,
"IsDisclaimerInCertificate": true,
"IsShareTemplateRule": true,
"AccessAuthenticatedDisplayOptionSelected": 45,
"AccessAuthenticationId": "4b4a06a0-bc2d-4e86-b773-c0d2fec6782c",
"AccessAuthenticationType": [
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  },
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  }
],
"AccessPassword": "sample string 47",
"IsAccessCodeSendToSignerEnabled": true,
"StoreEmailBody": true,
"AllowUserToDeleteEmailBody": true,
"DicLabelText": {
  "e47d871f-6cbc-4ff9-b0ec-ac736da34809": "sample string 1",
  "dcd74067-1378-4fea-a9ea-8c69701c84a9": "sample string 2"
},
"FinalContractOptions": [
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  },
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  }
],
"FinalContractOptionID": 51,
"SignatureControlRequired": true,
"EsignMailCopyAddress": "sample string 53",
"EsignMailRerouteAddress": "sample string 54",
"ReceiveSendingEmailConfirmation": true,
"AttachSignedPdf": [
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  },
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  }
],
"AttachSignedPdfID": "ce000bb4-be32-46ad-bdb3-ff34baa1fc3d",
"HeaderFooterSettingOptions": [
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  },
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  }
],
"HeaderFooterSettingID": 57,
"IsPostSigningLandingPage": true,
"IsIncludeEnvelopeXmlData": true,
"IsAllowTemplateEditingDisplayOptionSelected": 60,
"AllowTemplateEditing": true,
"EnablePostSigningLoginPopup": true,
"IsCreateMessageTemplate": true,
"SettingDisplayOptions": [
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  },
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  }
],
"SendIndividualSignatureNotificationsOptionSelected": 64,
"SendIndividualSignatureNotifications": true,
"DatetoSignedDocNameSettingsOptions": [
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  },
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  }
],
"DatetoSignedDocNameSettingsOptionID": 66,
"SendFinalReminderBeforeExpDisplayOptionSelected": 67,
"SendFinalReminderBeforeExp": 68,
"SendFinalReminderBeforeExpDropdownSelected": "2b83fd13-a18d-4eef-9718-463e5ae7c08c",
"ThenRemindersDropdown": [
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  },
  {
    "Disabled": true,
    "Group": {
      "Disabled": true,
      "Name": "sample string 2"
    },
    "Selected": true,
    "Text": "sample string 3",
    "Value": "sample string 4"
  }
],
"IncludeDefaultSignReqForStaticTemplate": true,
"DefaultSignReqForStaticTemplateDisplayOptionSelected": 71,
"IsOutOfOfficeModeEnable": true,
"DateRangeFirstDay": "2020-06-05T08:23:40.9369248+00:00",
"DateRangeLastDay": "2020-06-05T08:23:40.9369248+00:00",
"CopyEmailAddrForOutOfOfficeMode": "sample string 73",
"RerouteEmailAddrForOutOfOfficeMode": "sample string 74",
"EnableDependenciesFeature": true,
"EnableDependenciesFeatureDisplayOptionSelected": 76,
"EnableIntegrationAccess": true,
"referenceKeyForIntegration": "sample string 78"
}
}

Was this page helpful?