Secured Signing API

<back to all web services

CombineRequest

The following routes are available for this service:
POST/Document/CombineReturns a combined documentReturns a document reference for the combined documents
CombineRequest Parameters:
NameParameterData TypeRequiredDescription
DocumentReferencesmodelstringYesCollection of document references to add to package
CombinedDocumentNamemodelstringYesDocument reference
ClientReferencemodelstringNoClient reference
FoldermodelstringNoPut the combined file 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
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/Combine HTTP/1.1 
Host: api.securedsigning.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CombineRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Requests">
  <ClientReference>String</ClientReference>
  <CombinedDocumentName>String</CombinedDocumentName>
  <DocumentReferences xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DocumentReferences>
  <Folder>String</Folder>
</CombineRequest>

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>