POST api/integrations/trust-gate/signpdf

Request Information

URI Parameters

None.

Body Parameters

SignPDFInputModel
NameDescriptionTypeAdditional information
userID

string

None.

FullName

string

None.

AuthFactor

string

None.

pageNoField

integer

None.

pageNoFieldSpecified

boolean

None.

pdfInBase64Field

string

None.

sigImageInBase64Field

string

None.

visibilityField

boolean

None.

visibilityFieldSpecified

boolean

None.

visibleOnEveryPagesField

boolean

None.

visibleOnEveryPagesFieldSpecified

boolean

None.

x1Field

integer

None.

x1FieldSpecified

boolean

None.

x2Field

integer

None.

x2FieldSpecified

boolean

None.

y1Field

integer

None.

y1FieldSpecified

boolean

None.

y2Field

integer

None.

y2FieldSpecified

boolean

None.

SignatureInfo

signatureDetails

None.

Request Formats

application/json, text/json

Sample:
{
  "userID": "sample string 1",
  "FullName": "sample string 2",
  "AuthFactor": "sample string 3",
  "pageNoField": 4,
  "pageNoFieldSpecified": true,
  "pdfInBase64Field": "sample string 6",
  "sigImageInBase64Field": "sample string 7",
  "visibilityField": true,
  "visibilityFieldSpecified": true,
  "visibleOnEveryPagesField": true,
  "visibleOnEveryPagesFieldSpecified": true,
  "x1Field": 12,
  "x1FieldSpecified": true,
  "x2Field": 14,
  "x2FieldSpecified": true,
  "y1Field": 16,
  "y1FieldSpecified": true,
  "y2Field": 18,
  "y2FieldSpecified": true,
  "SignatureInfo": {
    "pageNoField": 1,
    "pageNoFieldSpecified": true,
    "pdfInBase64Field": "sample string 3",
    "sigImageInBase64Field": "sample string 4",
    "visibilityField": true,
    "visibilityFieldSpecified": true,
    "visibleOnEveryPagesField": true,
    "visibleOnEveryPagesFieldSpecified": true,
    "x1Field": 9,
    "x1FieldSpecified": true,
    "x2Field": 11,
    "x2FieldSpecified": true,
    "y1Field": 13,
    "y1FieldSpecified": true,
    "y2Field": 15,
    "y2FieldSpecified": true,
    "PropertyChanged": null
  }
}

application/xml, text/xml

Sample:
<SignPDFInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.Property.API.Models.Trustgate">
  <AuthFactor>sample string 3</AuthFactor>
  <FullName>sample string 2</FullName>
  <SignatureInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/HyperQB.Property.API.TrustgateServiceRef">
    <d2p1:PropertyChanged xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel" i:nil="true" />
    <d2p1:pageNoField>1</d2p1:pageNoField>
    <d2p1:pageNoFieldSpecified>true</d2p1:pageNoFieldSpecified>
    <d2p1:pdfInBase64Field>sample string 3</d2p1:pdfInBase64Field>
    <d2p1:sigImageInBase64Field>sample string 4</d2p1:sigImageInBase64Field>
    <d2p1:visibilityField>true</d2p1:visibilityField>
    <d2p1:visibilityFieldSpecified>true</d2p1:visibilityFieldSpecified>
    <d2p1:visibleOnEveryPagesField>true</d2p1:visibleOnEveryPagesField>
    <d2p1:visibleOnEveryPagesFieldSpecified>true</d2p1:visibleOnEveryPagesFieldSpecified>
    <d2p1:x1Field>9</d2p1:x1Field>
    <d2p1:x1FieldSpecified>true</d2p1:x1FieldSpecified>
    <d2p1:x2Field>11</d2p1:x2Field>
    <d2p1:x2FieldSpecified>true</d2p1:x2FieldSpecified>
    <d2p1:y1Field>13</d2p1:y1Field>
    <d2p1:y1FieldSpecified>true</d2p1:y1FieldSpecified>
    <d2p1:y2Field>15</d2p1:y2Field>
    <d2p1:y2FieldSpecified>true</d2p1:y2FieldSpecified>
  </SignatureInfo>
  <pageNoField>4</pageNoField>
  <pageNoFieldSpecified>true</pageNoFieldSpecified>
  <pdfInBase64Field>sample string 6</pdfInBase64Field>
  <sigImageInBase64Field>sample string 7</sigImageInBase64Field>
  <userID>sample string 1</userID>
  <visibilityField>true</visibilityField>
  <visibilityFieldSpecified>true</visibilityFieldSpecified>
  <visibleOnEveryPagesField>true</visibleOnEveryPagesField>
  <visibleOnEveryPagesFieldSpecified>true</visibleOnEveryPagesFieldSpecified>
  <x1Field>12</x1Field>
  <x1FieldSpecified>true</x1FieldSpecified>
  <x2Field>14</x2Field>
  <x2FieldSpecified>true</x2FieldSpecified>
  <y1Field>16</y1Field>
  <y1FieldSpecified>true</y1FieldSpecified>
  <y2Field>18</y2Field>
  <y2FieldSpecified>true</y2FieldSpecified>
</SignPDFInputModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>