Secured Signing API

<back to all web services

UploadRequest

The following routes are available for this service:
POST/Document/UploadByUrlUploads a file by urlUploads a file using a url
UploadRequest Parameters:
NameParameterData TypeRequiredDescription
FilemodelobjectYesThe file infomation
FoldermodelstringNoUpload the file and put in a folder; Only 'InBox' supported; if put in inbox, the document will be charged and visible in web portal; by default, the document is in an invisible temporary folder and can only be used via API.

Allowable Values

  • InBox
MatterNumbermodelstringNoMatter/Ref Number
FileInfo Parameters:
NameParameterData TypeRequiredDescription
ClientReferencemodelstringNoThe reference of the document on client side
FileInfoBase Parameters:
NameParameterData TypeRequiredDescription
NamemodelstringYesFile Name
FileTypemodelstringYesFile type of file

Allowable Values

  • pdf
  • doc
  • docx
  • rtf
FileUrlmodelstringYesUrl to download retrieve file data
DocumentReferenceResponse Parameters:
NameParameterData TypeRequiredDescription
ReferenceformstringYesDocument reference, used for document access

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/UploadByUrl HTTP/1.1 
Host: api.securedsigning.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Requests">
  <File xmlns:d2p1="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
    <d2p1:FileType>String</d2p1:FileType>
    <d2p1:FileUrl>String</d2p1:FileUrl>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:ClientReference>String</d2p1:ClientReference>
  </File>
  <Folder>String</Folder>
  <MatterNumber>String</MatterNumber>
</UploadRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentReferenceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
  <Reference>String</Reference>
</DocumentReferenceResponse>