RMail API

Back to Envelope(v1)

POST api/V1/Envelope/InitializeEnvelope

This will create a blank envelope and return Envelope Id.

Prerequisites

To be implemented

Request Information

Lorem ipsum

URI Parameters

None

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

Name Description Type Additional information
DateFormatID This will set Date Format Id of envelope. GUID None
ExpiryTypeID This will set Expiry Type Id of envelope. GUID None
IsTransparencyDocReq This will set transparency document required for envelope or not boolean None
IsSignerAttachFileReq This will return envelope IsSignerAttachFileReq flag boolean None
IpAddress This will set Password to open of envelope. string None
RecipientEmail This will set Recipient Email. string None
IsEnvelopeComplete This will set Envelope Status. boolean None
StaticTemplateID This will set Envelope Status. globally unique identifier None
ControlCollection This will set Control properties. Collection of DocumentContentDetails None
SenderUserId This will set Sender UserId properties. globally unique identifier None
Comment This will return comment string None
IsStatic boolean None
IsAttachXMLDataReq This will return envelope IsAttachXMLData for template flag boolean None
IsSeparateMultipleDocumentsAfterSigningRequired This will return envelope IsSeparateMultipleDocumentsAfterSigningRequired flag boolean None
IsConfirmationEmailReq This will return if confirmation email is required for static template boolean None
IsDisclaimerInCertificate This will return Is Disclaimer In Certificate boolean None
AccessAuthenticationType This will return access auth type for envelope globally unique identifier None
AccessAuthenticationPassword This will set access authentication password string None
IsPasswordMailToSigner This will return if sender want to send password by eSign or manually. boolean None
CultureInfo This will return envelope CultureInfo string None
CertificateSignature This will return certificate Signature string None
IsEdited This will return IsEdited flag of envelope boolean None
PostSigningLandingPage This will set Post Signing Landing Page . string None
ReminderTypeID globally unique identifier None
ThenReminderTypeID globally unique identifier None
MessageTemplateTextID globally unique identifier None
SendIndividualSignatureNotifications boolean None
DeclineReasonID integer None

Request Formats

application/json, text/json
Sample:
{
"DateFormatID": "00000000-0000-0000-0000-000000000000",
"ExpiryTypeID": "00000000-0000-0000-0000-000000000000",
"PasswordRequiredToSign": true,
"PasswordRequiredToOpen": true,
"PasswordToSign": "sample string 5",
"PasswordToOpen": "sample string 6",
"IsTransparencyDocReq": true,
"IsSignerAttachFileReq": true,
"IpAddress": "sample string 9",
"RecipientEmail": "sample string 10",
"IsEnvelopeComplete": true,
"StaticTemplateID": "2f5022cf-2f61-4a7a-87e4-78f5e83e0571",
"ControlCollection": [
  {
    "ControlHtmlData": "sample string 1",
    "ControlHtmlID": "sample string 2",
    "ControlID": "44604ba5-3977-477b-a32d-58b2ebfbc1c0",
    "DocumentID": "85eb393e-c3ab-4498-8939-df17dacb7306",
    "GroupName": "sample string 5",
    "Height": 1,
    "ID": "4e57d3a3-0691-462a-9167-49983f3efece",
    "Label": "sample string 7",
    "PageNo": 1,
    "DocumentPageNo": 1,
    "RecipientID": "16b59a18-5ab2-464c-b233-01c2838977ec",
    "MappedTemplateControlID": "d264b8f2-b317-41b4-9c33-be0468f62372",
    "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": "7c29fc87-8f4f-4f40-8684-7923e1753d50",
        "FontName": "sample string 2",
        "FontSize": 64,
        "FontColor": "sample string 4",
        "IsBold": true,
        "IsItalic": true,
        "IsUnderline": true
      },
      {
        "FontID": "7c29fc87-8f4f-4f40-8684-7923e1753d50",
        "FontName": "sample string 2",
        "FontSize": 64,
        "FontColor": "sample string 4",
        "IsBold": true,
        "IsItalic": true,
        "IsUnderline": true
      }
    ],
    "ControlStyle": {
      "FontID": "7c29fc87-8f4f-4f40-8684-7923e1753d50",
      "FontName": "sample string 2",
      "FontSize": 64,
      "FontColor": "sample string 4",
      "IsBold": true,
      "IsItalic": true,
      "IsUnderline": true
    },
    "SelectControlOptions": [
      {
        "DocumentContentID": "09f33f59-9759-46c3-a570-c159b6da745f",
        "ID": "086be222-1c35-4605-b63a-3269329733dd",
        "OptionText": "sample string 3",
        "Order": 4
      },
      {
        "DocumentContentID": "09f33f59-9759-46c3-a570-c159b6da745f",
        "ID": "086be222-1c35-4605-b63a-3269329733dd",
        "OptionText": "sample string 3",
        "Order": 4
      }
    ],
    "DependentFields": [
      {
        "ID": "b6920d85-f27e-414f-8cb9-777d7c531693",
        "ControlID": "435c9b1a-0b80-40e8-a403-7ff46a838127",
        "ConditionID": "7a5c2e2a-468f-4120-83a9-1636656ca7f1",
        "SupportText": "sample string 3",
        "GroupCode": 1.0,
        "IsRequired": true
      },
      {
        "ID": "b6920d85-f27e-414f-8cb9-777d7c531693",
        "ControlID": "435c9b1a-0b80-40e8-a403-7ff46a838127",
        "ConditionID": "7a5c2e2a-468f-4120-83a9-1636656ca7f1",
        "SupportText": "sample string 3",
        "GroupCode": 1.0,
        "IsRequired": true
      }
    ],
    "LeftIndex": 1.1,
    "TopIndex": 1.1,
    "ConditionalControlsDetails": {
      "ID": "197eaf52-5931-4754-82bb-ee6acb974410",
      "EnvelopeID": "cf98455b-43cb-45aa-a344-f43b1e133f1c",
      "ControlID": "404ba53f-6d06-4d61-b766-372e11dfac8b",
      "ControllingFieldID": "7430fed7-22da-43c6-afec-d04511ce0422",
      "ControllingConditionID": "9d1c7281-c90a-439c-b32b-513d5e1ca89c",
      "ControllingSupportText": "sample string 4",
      "EnvelopeStage": "sample string 5",
      "DependentFields": [
        {
          "ID": "b6920d85-f27e-414f-8cb9-777d7c531693",
          "ControlID": "435c9b1a-0b80-40e8-a403-7ff46a838127",
          "ConditionID": "7a5c2e2a-468f-4120-83a9-1636656ca7f1",
          "SupportText": "sample string 3",
          "GroupCode": 1.0,
          "IsRequired": true
        },
        {
          "ID": "b6920d85-f27e-414f-8cb9-777d7c531693",
          "ControlID": "435c9b1a-0b80-40e8-a403-7ff46a838127",
          "ConditionID": "7a5c2e2a-468f-4120-83a9-1636656ca7f1",
          "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": "44604ba5-3977-477b-a32d-58b2ebfbc1c0",
    "DocumentID": "85eb393e-c3ab-4498-8939-df17dacb7306",
    "GroupName": "sample string 5",
    "Height": 1,
    "ID": "4e57d3a3-0691-462a-9167-49983f3efece",
    "Label": "sample string 7",
    "PageNo": 1,
    "DocumentPageNo": 1,
    "RecipientID": "16b59a18-5ab2-464c-b233-01c2838977ec",
    "MappedTemplateControlID": "d264b8f2-b317-41b4-9c33-be0468f62372",
    "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": "7c29fc87-8f4f-4f40-8684-7923e1753d50",
        "FontName": "sample string 2",
        "FontSize": 64,
        "FontColor": "sample string 4",
        "IsBold": true,
        "IsItalic": true,
        "IsUnderline": true
      },
      {
        "FontID": "7c29fc87-8f4f-4f40-8684-7923e1753d50",
        "FontName": "sample string 2",
        "FontSize": 64,
        "FontColor": "sample string 4",
        "IsBold": true,
        "IsItalic": true,
        "IsUnderline": true
      }
    ],
    "ControlStyle": {
      "FontID": "7c29fc87-8f4f-4f40-8684-7923e1753d50",
      "FontName": "sample string 2",
      "FontSize": 64,
      "FontColor": "sample string 4",
      "IsBold": true,
      "IsItalic": true,
      "IsUnderline": true
    },
    "SelectControlOptions": [
      {
        "DocumentContentID": "09f33f59-9759-46c3-a570-c159b6da745f",
        "ID": "086be222-1c35-4605-b63a-3269329733dd",
        "OptionText": "sample string 3",
        "Order": 4
      },
      {
        "DocumentContentID": "09f33f59-9759-46c3-a570-c159b6da745f",
        "ID": "086be222-1c35-4605-b63a-3269329733dd",
        "OptionText": "sample string 3",
        "Order": 4
      }
    ],
    "DependentFields": [
      {
        "ID": "b6920d85-f27e-414f-8cb9-777d7c531693",
        "ControlID": "435c9b1a-0b80-40e8-a403-7ff46a838127",
        "ConditionID": "7a5c2e2a-468f-4120-83a9-1636656ca7f1",
        "SupportText": "sample string 3",
        "GroupCode": 1.0,
        "IsRequired": true
      },
      {
        "ID": "b6920d85-f27e-414f-8cb9-777d7c531693",
        "ControlID": "435c9b1a-0b80-40e8-a403-7ff46a838127",
        "ConditionID": "7a5c2e2a-468f-4120-83a9-1636656ca7f1",
        "SupportText": "sample string 3",
        "GroupCode": 1.0,
        "IsRequired": true
      }
    ],
    "LeftIndex": 1.1,
    "TopIndex": 1.1,
    "ConditionalControlsDetails": {
      "ID": "197eaf52-5931-4754-82bb-ee6acb974410",
      "EnvelopeID": "cf98455b-43cb-45aa-a344-f43b1e133f1c",
      "ControlID": "404ba53f-6d06-4d61-b766-372e11dfac8b",
      "ControllingFieldID": "7430fed7-22da-43c6-afec-d04511ce0422",
      "ControllingConditionID": "9d1c7281-c90a-439c-b32b-513d5e1ca89c",
      "ControllingSupportText": "sample string 4",
      "EnvelopeStage": "sample string 5",
      "DependentFields": [
        {
          "ID": "b6920d85-f27e-414f-8cb9-777d7c531693",
          "ControlID": "435c9b1a-0b80-40e8-a403-7ff46a838127",
          "ConditionID": "7a5c2e2a-468f-4120-83a9-1636656ca7f1",
          "SupportText": "sample string 3",
          "GroupCode": 1.0,
          "IsRequired": true
        },
        {
          "ID": "b6920d85-f27e-414f-8cb9-777d7c531693",
          "ControlID": "435c9b1a-0b80-40e8-a403-7ff46a838127",
          "ConditionID": "7a5c2e2a-468f-4120-83a9-1636656ca7f1",
          "SupportText": "sample string 3",
          "GroupCode": 1.0,
          "IsRequired": true
        }
      ],
      "GroupCode": 1.0,
      "IsRequired": "sample string 6"
    }
  }
],
"SenderUserId": "33eb2604-8ef8-4f42-a235-4a563d5e7e82",
"Comment": "sample string 14",
"IsStatic": true,
"IsAttachXMLDataReq": true,
"IsSeparateMultipleDocumentsAfterSigningRequired": true,
"IsConfirmationEmailReq": true,
"IsDisclaimerInCertificate": true,
"AccessAuthenticationType": "5e9ff98c-6f9b-4e05-ada6-ece5c8dc5bc2",
"AccessAuthenticationPassword": "sample string 19",
"IsRandomPassword": true,
"IsPasswordMailToSigner": true,
"AccessAuthType": "sample string 22",
"CultureInfo": "sample string 23",
"CertificateSignature": "sample string 24",
"IsEdited": true,
"PostSigningLandingPage": "sample string 25",
"ReminderTypeID": "a418f588-083f-420d-89e8-f00136a3a1b6",
"ThenReminderTypeID": "2b0511d2-c875-4fbc-8785-03ff7af032f3",
"MessageTemplateTextID": "aaab5cc3-32c7-4794-b38d-416e9339bc60",
"SendIndividualSignatureNotifications": true,
"DeclineReasonID": 1
}
application/xml, text/xml
Sample:
<APIEnvelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<DateFormatID>00000000-0000-0000-0000-000000000000</DateFormatID>
<ExpiryTypeID>00000000-0000-0000-0000-000000000000</ExpiryTypeID>
<IsTransparencyDocReq>true</IsTransparencyDocReq>
<IsSignerAttachFileReq>true</IsSignerAttachFileReq>
<IpAddress>sample string 9</IpAddress>
<RecipientEmail>sample string 10</RecipientEmail>
<IsEnvelopeComplete>true</IsEnvelopeComplete>
<StaticTemplateID>2f5022cf-2f61-4a7a-87e4-78f5e83e0571</StaticTemplateID>
<ControlCollection>
  <DocumentContentDetails>
    <ControlHtmlData>sample string 1</ControlHtmlData>
    <ControlHtmlID>sample string 2</ControlHtmlID>
    <ControlID>44604ba5-3977-477b-a32d-58b2ebfbc1c0</ControlID>
    <DocumentID>85eb393e-c3ab-4498-8939-df17dacb7306</DocumentID>
    <GroupName>sample string 5</GroupName>
    <Height>1</Height>
    <ID>4e57d3a3-0691-462a-9167-49983f3efece</ID>
    <Label>sample string 7</Label>
    <PageNo>1</PageNo>
    <DocumentPageNo>1</DocumentPageNo>
    <RecipientID>16b59a18-5ab2-464c-b233-01c2838977ec</RecipientID>
    <MappedTemplateControlID>d264b8f2-b317-41b4-9c33-be0468f62372</MappedTemplateControlID>
    <Required>true</Required>
    <SenderControlValue>sample string 9</SenderControlValue>
    <Width>1</Width>
    <XCoordinate>1</XCoordinate>
    <YCoordinate>1</YCoordinate>
    <ZCoordinate>1</ZCoordinate>
    <ControlValue>sample string 10</ControlValue>
    <RecipientName>sample string 11</RecipientName>
    <MaxLength>sample string 12</MaxLength>
    <TextType>sample string 13</TextType>
    <controlStyleDetails>
      <ControlStyleDetails>
        <FontID>7c29fc87-8f4f-4f40-8684-7923e1753d50</FontID>
        <FontName>sample string 2</FontName>
        <FontSize>64</FontSize>
        <FontColor>sample string 4</FontColor>
        <IsBold>true</IsBold>
        <IsItalic>true</IsItalic>
        <IsUnderline>true</IsUnderline>
      </ControlStyleDetails>
      <ControlStyleDetails>
        <FontID>7c29fc87-8f4f-4f40-8684-7923e1753d50</FontID>
        <FontName>sample string 2</FontName>
        <FontSize>64</FontSize>
        <FontColor>sample string 4</FontColor>
        <IsBold>true</IsBold>
        <IsItalic>true</IsItalic>
        <IsUnderline>true</IsUnderline>
      </ControlStyleDetails>
    </controlStyleDetails>
    <ControlStyle>
      <FontID>7c29fc87-8f4f-4f40-8684-7923e1753d50</FontID>
      <FontName>sample string 2</FontName>
      <FontSize>64</FontSize>
      <FontColor>sample string 4</FontColor>
      <IsBold>true</IsBold>
      <IsItalic>true</IsItalic>
      <IsUnderline>true</IsUnderline>
    </ControlStyle>
    <SelectControlOptions>
      <SelectControlOptionDetails>
        <DocumentContentID>09f33f59-9759-46c3-a570-c159b6da745f</DocumentContentID>
        <ID>086be222-1c35-4605-b63a-3269329733dd</ID>
        <OptionText>sample string 3</OptionText>
        <Order>4</Order>
      </SelectControlOptionDetails>
      <SelectControlOptionDetails>
        <DocumentContentID>09f33f59-9759-46c3-a570-c159b6da745f</DocumentContentID>
        <ID>086be222-1c35-4605-b63a-3269329733dd</ID>
        <OptionText>sample string 3</OptionText>
        <Order>4</Order>
      </SelectControlOptionDetails>
    </SelectControlOptions>
    <DependentFields>
      <DependentFieldsPOCO>
        <ID>b6920d85-f27e-414f-8cb9-777d7c531693</ID>
        <ControlID>435c9b1a-0b80-40e8-a403-7ff46a838127</ControlID>
        <ConditionID>7a5c2e2a-468f-4120-83a9-1636656ca7f1</ConditionID>
        <SupportText>sample string 3</SupportText>
        <GroupCode>1</GroupCode>
        <IsRequired>true</IsRequired>
      </DependentFieldsPOCO>
      <DependentFieldsPOCO>
        <ID>b6920d85-f27e-414f-8cb9-777d7c531693</ID>
        <ControlID>435c9b1a-0b80-40e8-a403-7ff46a838127</ControlID>
        <ConditionID>7a5c2e2a-468f-4120-83a9-1636656ca7f1</ConditionID>
        <SupportText>sample string 3</SupportText>
        <GroupCode>1</GroupCode>
        <IsRequired>true</IsRequired>
      </DependentFieldsPOCO>
    </DependentFields>
    <LeftIndex>1.1</LeftIndex>
    <TopIndex>1.1</TopIndex>
    <ConditionalControlsDetails>
      <ID>197eaf52-5931-4754-82bb-ee6acb974410</ID>
      <EnvelopeID>cf98455b-43cb-45aa-a344-f43b1e133f1c</EnvelopeID>
      <ControlID>404ba53f-6d06-4d61-b766-372e11dfac8b</ControlID>
      <ControllingFieldID>7430fed7-22da-43c6-afec-d04511ce0422</ControllingFieldID>
      <ControllingConditionID>9d1c7281-c90a-439c-b32b-513d5e1ca89c</ControllingConditionID>
      <ControllingSupportText>sample string 4</ControllingSupportText>
      <EnvelopeStage>sample string 5</EnvelopeStage>
      <DependentFields>
        <DependentFieldsPOCO>
          <ID>b6920d85-f27e-414f-8cb9-777d7c531693</ID>
          <ControlID>435c9b1a-0b80-40e8-a403-7ff46a838127</ControlID>
          <ConditionID>7a5c2e2a-468f-4120-83a9-1636656ca7f1</ConditionID>
          <SupportText>sample string 3</SupportText>
          <GroupCode>1</GroupCode>
          <IsRequired>true</IsRequired>
        </DependentFieldsPOCO>
        <DependentFieldsPOCO>
          <ID>b6920d85-f27e-414f-8cb9-777d7c531693</ID>
          <ControlID>435c9b1a-0b80-40e8-a403-7ff46a838127</ControlID>
          <ConditionID>7a5c2e2a-468f-4120-83a9-1636656ca7f1</ConditionID>
          <SupportText>sample string 3</SupportText>
          <GroupCode>1</GroupCode>
          <IsRequired>true</IsRequired>
        </DependentFieldsPOCO>
      </DependentFields>
      <GroupCode>1</GroupCode>
      <IsRequired>sample string 6</IsRequired>
    </ConditionalControlsDetails>
  </DocumentContentDetails>
  <DocumentContentDetails>
    <ControlHtmlData>sample string 1</ControlHtmlData>
    <ControlHtmlID>sample string 2</ControlHtmlID>
    <ControlID>44604ba5-3977-477b-a32d-58b2ebfbc1c0</ControlID>
    <DocumentID>85eb393e-c3ab-4498-8939-df17dacb7306</DocumentID>
    <GroupName>sample string 5</GroupName>
    <Height>1</Height>
    <ID>4e57d3a3-0691-462a-9167-49983f3efece</ID>
    <Label>sample string 7</Label>
    <PageNo>1</PageNo>
    <DocumentPageNo>1</DocumentPageNo>
    <RecipientID>16b59a18-5ab2-464c-b233-01c2838977ec</RecipientID>
    <MappedTemplateControlID>d264b8f2-b317-41b4-9c33-be0468f62372</MappedTemplateControlID>
    <Required>true</Required>
    <SenderControlValue>sample string 9</SenderControlValue>
    <Width>1</Width>
    <XCoordinate>1</XCoordinate>
    <YCoordinate>1</YCoordinate>
    <ZCoordinate>1</ZCoordinate>
    <ControlValue>sample string 10</ControlValue>
    <RecipientName>sample string 11</RecipientName>
    <MaxLength>sample string 12</MaxLength>
    <TextType>sample string 13</TextType>
    <controlStyleDetails>
      <ControlStyleDetails>
        <FontID>7c29fc87-8f4f-4f40-8684-7923e1753d50</FontID>
        <FontName>sample string 2</FontName>
        <FontSize>64</FontSize>
        <FontColor>sample string 4</FontColor>
        <IsBold>true</IsBold>
        <IsItalic>true</IsItalic>
        <IsUnderline>true</IsUnderline>
      </ControlStyleDetails>
      <ControlStyleDetails>
        <FontID>7c29fc87-8f4f-4f40-8684-7923e1753d50</FontID>
        <FontName>sample string 2</FontName>
        <FontSize>64</FontSize>
        <FontColor>sample string 4</FontColor>
        <IsBold>true</IsBold>
        <IsItalic>true</IsItalic>
        <IsUnderline>true</IsUnderline>
      </ControlStyleDetails>
    </controlStyleDetails>
    <ControlStyle>
      <FontID>7c29fc87-8f4f-4f40-8684-7923e1753d50</FontID>
      <FontName>sample string 2</FontName>
      <FontSize>64</FontSize>
      <FontColor>sample string 4</FontColor>
      <IsBold>true</IsBold>
      <IsItalic>true</IsItalic>
      <IsUnderline>true</IsUnderline>
    </ControlStyle>
    <SelectControlOptions>
      <SelectControlOptionDetails>
        <DocumentContentID>09f33f59-9759-46c3-a570-c159b6da745f</DocumentContentID>
        <ID>086be222-1c35-4605-b63a-3269329733dd</ID>
        <OptionText>sample string 3</OptionText>
        <Order>4</Order>
      </SelectControlOptionDetails>
      <SelectControlOptionDetails>
        <DocumentContentID>09f33f59-9759-46c3-a570-c159b6da745f</DocumentContentID>
        <ID>086be222-1c35-4605-b63a-3269329733dd</ID>
        <OptionText>sample string 3</OptionText>
        <Order>4</Order>
      </SelectControlOptionDetails>
    </SelectControlOptions>
    <DependentFields>
      <DependentFieldsPOCO>
        <ID>b6920d85-f27e-414f-8cb9-777d7c531693</ID>
        <ControlID>435c9b1a-0b80-40e8-a403-7ff46a838127</ControlID>
        <ConditionID>7a5c2e2a-468f-4120-83a9-1636656ca7f1</ConditionID>
        <SupportText>sample string 3</SupportText>
        <GroupCode>1</GroupCode>
        <IsRequired>true</IsRequired>
      </DependentFieldsPOCO>
      <DependentFieldsPOCO>
        <ID>b6920d85-f27e-414f-8cb9-777d7c531693</ID>
        <ControlID>435c9b1a-0b80-40e8-a403-7ff46a838127</ControlID>
        <ConditionID>7a5c2e2a-468f-4120-83a9-1636656ca7f1</ConditionID>
        <SupportText>sample string 3</SupportText>
        <GroupCode>1</GroupCode>
        <IsRequired>true</IsRequired>
      </DependentFieldsPOCO>
    </DependentFields>
    <LeftIndex>1.1</LeftIndex>
    <TopIndex>1.1</TopIndex>
    <ConditionalControlsDetails>
      <ID>197eaf52-5931-4754-82bb-ee6acb974410</ID>
      <EnvelopeID>cf98455b-43cb-45aa-a344-f43b1e133f1c</EnvelopeID>
      <ControlID>404ba53f-6d06-4d61-b766-372e11dfac8b</ControlID>
      <ControllingFieldID>7430fed7-22da-43c6-afec-d04511ce0422</ControllingFieldID>
      <ControllingConditionID>9d1c7281-c90a-439c-b32b-513d5e1ca89c</ControllingConditionID>
      <ControllingSupportText>sample string 4</ControllingSupportText>
      <EnvelopeStage>sample string 5</EnvelopeStage>
      <DependentFields>
        <DependentFieldsPOCO>
          <ID>b6920d85-f27e-414f-8cb9-777d7c531693</ID>
          <ControlID>435c9b1a-0b80-40e8-a403-7ff46a838127</ControlID>
          <ConditionID>7a5c2e2a-468f-4120-83a9-1636656ca7f1</ConditionID>
          <SupportText>sample string 3</SupportText>
          <GroupCode>1</GroupCode>
          <IsRequired>true</IsRequired>
        </DependentFieldsPOCO>
        <DependentFieldsPOCO>
          <ID>b6920d85-f27e-414f-8cb9-777d7c531693</ID>
          <ControlID>435c9b1a-0b80-40e8-a403-7ff46a838127</ControlID>
          <ConditionID>7a5c2e2a-468f-4120-83a9-1636656ca7f1</ConditionID>
          <SupportText>sample string 3</SupportText>
          <GroupCode>1</GroupCode>
          <IsRequired>true</IsRequired>
        </DependentFieldsPOCO>
      </DependentFields>
      <GroupCode>1</GroupCode>
      <IsRequired>sample string 6</IsRequired>
    </ConditionalControlsDetails>
  </DocumentContentDetails>
</ControlCollection>
<SenderUserId>33eb2604-8ef8-4f42-a235-4a563d5e7e82</SenderUserId>
<Comment>sample string 14</Comment>
<IsStatic>true</IsStatic>
<IsAttachXMLDataReq>true</IsAttachXMLDataReq>
<IsSeparateMultipleDocumentsAfterSigningRequired>true</IsSeparateMultipleDocumentsAfterSigningRequired>
<IsConfirmationEmailReq>true</IsConfirmationEmailReq>
<IsDisclaimerInCertificate>true</IsDisclaimerInCertificate>
<AccessAuthenticationType>5e9ff98c-6f9b-4e05-ada6-ece5c8dc5bc2</AccessAuthenticationType>
<AccessAuthenticationPassword>sample string 19</AccessAuthenticationPassword>
<IsPasswordMailToSigner>true</IsPasswordMailToSigner>
<CultureInfo>sample string 23</CultureInfo>
<CertificateSignature>sample string 24</CertificateSignature>
<IsEdited>true</IsEdited>
<PostSigningLandingPage>sample string 25</PostSigningLandingPage>
<ReminderTypeID>a418f588-083f-420d-89e8-f00136a3a1b6</ReminderTypeID>
<ThenReminderTypeID>2b0511d2-c875-4fbc-8785-03ff7af032f3</ThenReminderTypeID>
<MessageTemplateTextID>aaab5cc3-32c7-4794-b38d-416e9339bc60</MessageTemplateTextID>
<SendIndividualSignatureNotifications>true</SendIndividualSignatureNotifications>
<DeclineReasonID>1</DeclineReasonID>
</APIEnvelope>

Response Information

Resource Description

Name Description Type Additional information
StatusCode This will return Status Code. HttpStatusCode None
StatusMessage This will return Status Message. string None
Message This will return response message for corresponding status code. string None
EnvelopeID This will return Envelope Id. GUID None
EnvelopeCode This will return Envelope Code. string None
SignDoumentUrl This will return Sign Document Url. string None
RecipientList Collection of APIRecipientList None

Response Formats

application/json, text/json
Sample:
{
"StatusCode": 100,
"StatusMessage": "sample string 1",
"Message": "sample string 2",
"EnvelopeId": "300734a7-cfbd-4f65-be07-e7ac3c19b232",
"EnvelopeCode": "sample string 4",
"SignDoumentUrl": "sample string 5",
"RecipientList": [
{
  "RecipientName": "sample string 1",
  "RecipientEmail": "sample string 2",
  "Order": 1,
  "Type": "sample string 3",
  "SigningUrl": "sample string 4"
},
{
  "RecipientName": "sample string 1",
  "RecipientEmail": "sample string 2",
  "Order": 1,
  "Type": "sample string 3",
  "SigningUrl": "sample string 4"
}
]
}
application/xml, text/xml
Sample:
<ResponseMessageForEnvelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StatusCode>Continue</StatusCode>
  <StatusMessage>sample string 1</StatusMessage>
  <Message>sample string 2</Message>
  <EnvelopeId>300734a7-cfbd-4f65-be07-e7ac3c19b232</EnvelopeId>
  <EnvelopeCode>sample string 4</EnvelopeCode>
  <SignDoumentUrl>sample string 5</SignDoumentUrl>
  <RecipientList>
    <APIRecipientList>
      <RecipientName>sample string 1</RecipientName>
      <RecipientEmail>sample string 2</RecipientEmail>
      <Order>1</Order>
      <Type>sample string 3</Type>
      <SigningUrl>sample string 4</SigningUrl>
    </APIRecipientList>
    <APIRecipientList>
      <RecipientName>sample string 1</RecipientName>
      <RecipientEmail>sample string 2</RecipientEmail>
      <Order>1</Order>
      <Type>sample string 3</Type>
      <SigningUrl>sample string 4</SigningUrl>
    </APIRecipientList>
  </RecipientList>
</ResponseMessageForEnvelope>

Was this page helpful?

Yes No

About Us

Features

Related Websites

Success Stories

Customer Videos

Insights

More Insights

Industries

Pricing

Apps

Support

Sitemap

Training Videos

© 1999-2024 RPost. All Rights Reserved. Terms & Conditions, RMail | Gmail App Compliance.
RPost Patented (click for patent list).