GET | /Document/Validation/{DocumentReference} | validate document | Verifies the signatures in document. The document may not be found due to it being removed from Secured Signing according to our data retention policy. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentReference | path | string | Yes | Document reference |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Signatures | form | List<VerifySignature> | No | |
DocumentURL | form | string | No | |
DocumentName | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
isValid | form | bool | No | |
SignatureTime | form | string | No | |
User | form | string | No | |
Signer | form | VerifiedSignerResponse | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FirstName | form | string | Yes | First name of user |
LastName | form | string | Yes | Last name of user |
form | string | Yes | Email address of user | |
SignerType | form | string | No | Role of signer in signing process |
MobileNumber | form | string | No | Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc |
MobileCountry | form | string | No | Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc |
HasSigned | form | boolean | No | User signing status |
Title | form | string | No | |
Reason | form | string | No | |
Company | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Document/Validation/{DocumentReference} HTTP/1.1 Host: api.securedsigning.com Accept: application/xml
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>