POST api/RemoteSign

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ReferenceNo	string	None.
lstDocumentDetails	Collection of DocumentDetails	Required
SignatoryEmail	string	None.
SignatureImage	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ReferenceNo": "sample string 1",
  "lstDocumentDetails": [
    {
      "DocumentName": "sample string 1",
      "PullFileDataFromURL": true,
      "FileData": "sample string 3",
      "TemplateId": 4,
      "ControlDetails": [
        {
          "ControlID": 1,
          "AssignedTo": 2,
          "PageNo": "sample string 3",
          "Page": "sample string 4",
          "Left": 5,
          "Top": 6,
          "Height": 7,
          "Width": 8,
          "FontType": "sample string 9",
          "FontSize": 10,
          "PlaceHolder": "sample string 11",
          "ValidationType": "sample string 12",
          "SearchText": "sample string 13",
          "Anchor": "sample string 14",
          "InitialSearchText": "sample string 15",
          "InitialAnchor": "sample string 16",
          "EmateraiSearchtext": "sample string 17",
          "EmateraiaAnchor": "sample string 18",
          "SignerType": 19,
          "ControlValue": "sample string 20"
        },
        {
          "ControlID": 1,
          "AssignedTo": 2,
          "PageNo": "sample string 3",
          "Page": "sample string 4",
          "Left": 5,
          "Top": 6,
          "Height": 7,
          "Width": 8,
          "FontType": "sample string 9",
          "FontSize": 10,
          "PlaceHolder": "sample string 11",
          "ValidationType": "sample string 12",
          "SearchText": "sample string 13",
          "Anchor": "sample string 14",
          "InitialSearchText": "sample string 15",
          "InitialAnchor": "sample string 16",
          "EmateraiSearchtext": "sample string 17",
          "EmateraiaAnchor": "sample string 18",
          "SignerType": 19,
          "ControlValue": "sample string 20"
        }
      ],
      "QRCodeCordinats": [
        {
          "Left": 1,
          "Height": 2,
          "PageNumber": "sample string 3",
          "SelectedPage": "sample string 4",
          "Top": 5,
          "Width": 6
        },
        {
          "Left": 1,
          "Height": 2,
          "PageNumber": "sample string 3",
          "SelectedPage": "sample string 4",
          "Top": 5,
          "Width": 6
        }
      ],
      "MergeDocumentDetails": [
        {
          "DocumentName": "sample string 1",
          "FileData": "sample string 2",
          "AddSignaturePlaceholder": true,
          "ParentDocumentId": 4
        },
        {
          "DocumentName": "sample string 1",
          "FileData": "sample string 2",
          "AddSignaturePlaceholder": true,
          "ParentDocumentId": 4
        }
      ]
    },
    {
      "DocumentName": "sample string 1",
      "PullFileDataFromURL": true,
      "FileData": "sample string 3",
      "TemplateId": 4,
      "ControlDetails": [
        {
          "ControlID": 1,
          "AssignedTo": 2,
          "PageNo": "sample string 3",
          "Page": "sample string 4",
          "Left": 5,
          "Top": 6,
          "Height": 7,
          "Width": 8,
          "FontType": "sample string 9",
          "FontSize": 10,
          "PlaceHolder": "sample string 11",
          "ValidationType": "sample string 12",
          "SearchText": "sample string 13",
          "Anchor": "sample string 14",
          "InitialSearchText": "sample string 15",
          "InitialAnchor": "sample string 16",
          "EmateraiSearchtext": "sample string 17",
          "EmateraiaAnchor": "sample string 18",
          "SignerType": 19,
          "ControlValue": "sample string 20"
        },
        {
          "ControlID": 1,
          "AssignedTo": 2,
          "PageNo": "sample string 3",
          "Page": "sample string 4",
          "Left": 5,
          "Top": 6,
          "Height": 7,
          "Width": 8,
          "FontType": "sample string 9",
          "FontSize": 10,
          "PlaceHolder": "sample string 11",
          "ValidationType": "sample string 12",
          "SearchText": "sample string 13",
          "Anchor": "sample string 14",
          "InitialSearchText": "sample string 15",
          "InitialAnchor": "sample string 16",
          "EmateraiSearchtext": "sample string 17",
          "EmateraiaAnchor": "sample string 18",
          "SignerType": 19,
          "ControlValue": "sample string 20"
        }
      ],
      "QRCodeCordinats": [
        {
          "Left": 1,
          "Height": 2,
          "PageNumber": "sample string 3",
          "SelectedPage": "sample string 4",
          "Top": 5,
          "Width": 6
        },
        {
          "Left": 1,
          "Height": 2,
          "PageNumber": "sample string 3",
          "SelectedPage": "sample string 4",
          "Top": 5,
          "Width": 6
        }
      ],
      "MergeDocumentDetails": [
        {
          "DocumentName": "sample string 1",
          "FileData": "sample string 2",
          "AddSignaturePlaceholder": true,
          "ParentDocumentId": 4
        },
        {
          "DocumentName": "sample string 1",
          "FileData": "sample string 2",
          "AddSignaturePlaceholder": true,
          "ParentDocumentId": 4
        }
      ]
    }
  ],
  "SignatoryEmail": "sample string 2",
  "SignatureImage": "sample string 3"
}

application/xml, text/xml

Sample:

<RemoteSigningRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ReferenceNo>sample string 1</ReferenceNo>
  <lstDocumentDetails>
    <DocumentDetails>
      <DocumentName>sample string 1</DocumentName>
      <PullFileDataFromURL>true</PullFileDataFromURL>
      <FileData>sample string 3</FileData>
      <TemplateId>4</TemplateId>
      <ControlDetails>
        <BulkPFConfigViewModel>
          <ControlID>1</ControlID>
          <AssignedTo>2</AssignedTo>
          <PageNo>sample string 3</PageNo>
          <Page>sample string 4</Page>
          <Left>5</Left>
          <Top>6</Top>
          <Height>7</Height>
          <Width>8</Width>
          <FontType>sample string 9</FontType>
          <FontSize>10</FontSize>
          <PlaceHolder>sample string 11</PlaceHolder>
          <ValidationType>sample string 12</ValidationType>
          <SearchText>sample string 13</SearchText>
          <Anchor>sample string 14</Anchor>
          <InitialSearchText>sample string 15</InitialSearchText>
          <InitialAnchor>sample string 16</InitialAnchor>
          <EmateraiSearchtext>sample string 17</EmateraiSearchtext>
          <EmateraiaAnchor>sample string 18</EmateraiaAnchor>
          <SignerType>19</SignerType>
          <ControlValue>sample string 20</ControlValue>
        </BulkPFConfigViewModel>
        <BulkPFConfigViewModel>
          <ControlID>1</ControlID>
          <AssignedTo>2</AssignedTo>
          <PageNo>sample string 3</PageNo>
          <Page>sample string 4</Page>
          <Left>5</Left>
          <Top>6</Top>
          <Height>7</Height>
          <Width>8</Width>
          <FontType>sample string 9</FontType>
          <FontSize>10</FontSize>
          <PlaceHolder>sample string 11</PlaceHolder>
          <ValidationType>sample string 12</ValidationType>
          <SearchText>sample string 13</SearchText>
          <Anchor>sample string 14</Anchor>
          <InitialSearchText>sample string 15</InitialSearchText>
          <InitialAnchor>sample string 16</InitialAnchor>
          <EmateraiSearchtext>sample string 17</EmateraiSearchtext>
          <EmateraiaAnchor>sample string 18</EmateraiaAnchor>
          <SignerType>19</SignerType>
          <ControlValue>sample string 20</ControlValue>
        </BulkPFConfigViewModel>
      </ControlDetails>
      <QRCodeCordinats>
        <OnlineFlexiQRCoordinate>
          <Left>1</Left>
          <Height>2</Height>
          <PageNumber>sample string 3</PageNumber>
          <SelectedPage>sample string 4</SelectedPage>
          <Top>5</Top>
          <Width>6</Width>
        </OnlineFlexiQRCoordinate>
        <OnlineFlexiQRCoordinate>
          <Left>1</Left>
          <Height>2</Height>
          <PageNumber>sample string 3</PageNumber>
          <SelectedPage>sample string 4</SelectedPage>
          <Top>5</Top>
          <Width>6</Width>
        </OnlineFlexiQRCoordinate>
      </QRCodeCordinats>
      <MergeDocumentDetails>
        <MergeDocumentmentDetails>
          <DocumentName>sample string 1</DocumentName>
          <FileData>sample string 2</FileData>
          <AddSignaturePlaceholder>true</AddSignaturePlaceholder>
          <ParentDocumentId>4</ParentDocumentId>
        </MergeDocumentmentDetails>
        <MergeDocumentmentDetails>
          <DocumentName>sample string 1</DocumentName>
          <FileData>sample string 2</FileData>
          <AddSignaturePlaceholder>true</AddSignaturePlaceholder>
          <ParentDocumentId>4</ParentDocumentId>
        </MergeDocumentmentDetails>
      </MergeDocumentDetails>
    </DocumentDetails>
    <DocumentDetails>
      <DocumentName>sample string 1</DocumentName>
      <PullFileDataFromURL>true</PullFileDataFromURL>
      <FileData>sample string 3</FileData>
      <TemplateId>4</TemplateId>
      <ControlDetails>
        <BulkPFConfigViewModel>
          <ControlID>1</ControlID>
          <AssignedTo>2</AssignedTo>
          <PageNo>sample string 3</PageNo>
          <Page>sample string 4</Page>
          <Left>5</Left>
          <Top>6</Top>
          <Height>7</Height>
          <Width>8</Width>
          <FontType>sample string 9</FontType>
          <FontSize>10</FontSize>
          <PlaceHolder>sample string 11</PlaceHolder>
          <ValidationType>sample string 12</ValidationType>
          <SearchText>sample string 13</SearchText>
          <Anchor>sample string 14</Anchor>
          <InitialSearchText>sample string 15</InitialSearchText>
          <InitialAnchor>sample string 16</InitialAnchor>
          <EmateraiSearchtext>sample string 17</EmateraiSearchtext>
          <EmateraiaAnchor>sample string 18</EmateraiaAnchor>
          <SignerType>19</SignerType>
          <ControlValue>sample string 20</ControlValue>
        </BulkPFConfigViewModel>
        <BulkPFConfigViewModel>
          <ControlID>1</ControlID>
          <AssignedTo>2</AssignedTo>
          <PageNo>sample string 3</PageNo>
          <Page>sample string 4</Page>
          <Left>5</Left>
          <Top>6</Top>
          <Height>7</Height>
          <Width>8</Width>
          <FontType>sample string 9</FontType>
          <FontSize>10</FontSize>
          <PlaceHolder>sample string 11</PlaceHolder>
          <ValidationType>sample string 12</ValidationType>
          <SearchText>sample string 13</SearchText>
          <Anchor>sample string 14</Anchor>
          <InitialSearchText>sample string 15</InitialSearchText>
          <InitialAnchor>sample string 16</InitialAnchor>
          <EmateraiSearchtext>sample string 17</EmateraiSearchtext>
          <EmateraiaAnchor>sample string 18</EmateraiaAnchor>
          <SignerType>19</SignerType>
          <ControlValue>sample string 20</ControlValue>
        </BulkPFConfigViewModel>
      </ControlDetails>
      <QRCodeCordinats>
        <OnlineFlexiQRCoordinate>
          <Left>1</Left>
          <Height>2</Height>
          <PageNumber>sample string 3</PageNumber>
          <SelectedPage>sample string 4</SelectedPage>
          <Top>5</Top>
          <Width>6</Width>
        </OnlineFlexiQRCoordinate>
        <OnlineFlexiQRCoordinate>
          <Left>1</Left>
          <Height>2</Height>
          <PageNumber>sample string 3</PageNumber>
          <SelectedPage>sample string 4</SelectedPage>
          <Top>5</Top>
          <Width>6</Width>
        </OnlineFlexiQRCoordinate>
      </QRCodeCordinats>
      <MergeDocumentDetails>
        <MergeDocumentmentDetails>
          <DocumentName>sample string 1</DocumentName>
          <FileData>sample string 2</FileData>
          <AddSignaturePlaceholder>true</AddSignaturePlaceholder>
          <ParentDocumentId>4</ParentDocumentId>
        </MergeDocumentmentDetails>
        <MergeDocumentmentDetails>
          <DocumentName>sample string 1</DocumentName>
          <FileData>sample string 2</FileData>
          <AddSignaturePlaceholder>true</AddSignaturePlaceholder>
          <ParentDocumentId>4</ParentDocumentId>
        </MergeDocumentmentDetails>
      </MergeDocumentDetails>
    </DocumentDetails>
  </lstDocumentDetails>
  <SignatoryEmail>sample string 2</SignatoryEmail>
  <SignatureImage>sample string 3</SignatureImage>
</RemoteSigningRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReturnObjectOfInitiateAndSignWorkFlowResponse

Name	Type	Additional information
IsSuccess	boolean	None.
Messages	Collection of string	None.
ErrorCode	integer	None.
Response	InitiateAndSignWorkFlowResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Messages": [
    "sample string 1",
    "sample string 2"
  ],
  "ErrorCode": 2,
  "Response": {
    "ReferenceNo": "sample string 1",
    "DocumentNumberList": [
      "sample string 1",
      "sample string 2"
    ],
    "DocumentIdList": [
      1,
      2
    ],
    "Status": true,
    "WorkflowId": 3,
    "URL": "sample string 4",
    "ParallelSigningURLs": [
      {
        "EmailId": "sample string 1",
        "URL": "sample string 2"
      },
      {
        "EmailId": "sample string 1",
        "URL": "sample string 2"
      }
    ],
    "TransactionNumber": "sample string 5",
    "RedirectURL": "sample string 6",
    "ResponseCode": "sample string 7"
  }
}

application/xml, text/xml

Sample:

<ReturnObjectOfInitiateAndSignWorkFlowResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsSuccess>true</IsSuccess>
  <Messages>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Messages>
  <ErrorCode>2</ErrorCode>
  <Response>
    <ReferenceNo>sample string 1</ReferenceNo>
    <DocumentNumberList>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </DocumentNumberList>
    <DocumentIdList>
      <long>1</long>
      <long>2</long>
    </DocumentIdList>
    <Status>true</Status>
    <WorkflowId>3</WorkflowId>
    <URL>sample string 4</URL>
    <ParallelSigningURLs>
      <ParallelSigningURL>
        <EmailId>sample string 1</EmailId>
        <URL>sample string 2</URL>
      </ParallelSigningURL>
      <ParallelSigningURL>
        <EmailId>sample string 1</EmailId>
        <URL>sample string 2</URL>
      </ParallelSigningURL>
    </ParallelSigningURLs>
    <TransactionNumber>sample string 5</TransactionNumber>
    <RedirectURL>sample string 6</RedirectURL>
    <ResponseCode>sample string 7</ResponseCode>
  </Response>
</ReturnObjectOfInitiateAndSignWorkFlowResponse>