Secured Signing API

<back to all web services

DocumentFileValidationRequest

The following routes are available for this service:
POST/Document/FileValidationvalidate documentVerifies the signatures in document. The document may not be found due to it being removed from Secured Signing according to our data retention policy.
DocumentFileValidationRequest Parameters:
NameParameterData TypeRequiredDescription
AnyThingmodelobjectYes
DocumentValidationResponse Parameters:
NameParameterData TypeRequiredDescription
SignaturesformList<VerifySignature>No
DocumentURLformstringNo
DocumentNameformstringNo
VerifySignature Parameters:
NameParameterData TypeRequiredDescription
isValidformboolNo
SignatureTimeformstringNo
UserformstringNo
SignerformVerifiedSignerResponseNo
VerifiedSignerResponse Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringYesFirst name of user
LastNameformstringYesLast name of user
EmailformstringYesEmail address of user
SignerTypeformstringNoRole of signer in signing process
MobileNumberformstringNoMobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc
MobileCountryformstringNoMobile Country code for phone number e.g. Australia 61, New Zealand 64 etc
HasSignedformbooleanNoUser signing status
TitleformstringNo
ReasonformstringNo
CompanyformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Document/FileValidation HTTP/1.1 
Host: api.securedsigning.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DocumentFileValidationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Requests">
  <AnyThing />
</DocumentFileValidationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentValidationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
  <DocumentName>String</DocumentName>
  <DocumentURL>String</DocumentURL>
  <Signatures>
    <VerifySignature>
      <SignatureTime>String</SignatureTime>
      <Signer>
        <Company>String</Company>
        <Email>String</Email>
        <FirstName>String</FirstName>
        <HasSigned>false</HasSigned>
        <LastName>String</LastName>
        <MobileCountry>String</MobileCountry>
        <MobileNumber>String</MobileNumber>
        <Reason>String</Reason>
        <SignerType>String</SignerType>
        <Title>String</Title>
      </Signer>
      <User>String</User>
      <isValid>false</isValid>
    </VerifySignature>
  </Signatures>
</DocumentValidationResponse>