Download

At any given stage of the order, you can download the uploaded version, of the documents of the order.

Note! The output from these methods tends to be quite large.

 

Models used in the response:

DeliverablesDocumentModel
Name Type Description Optional
Id String Order Id.
DocumentIndex Int Index of document (zero based index). You must specify this, DocumentId or AgreementId. yes
DocumentId Int Id of document. You must specify this, DocumentIndex or AgreementId. yes
AgreementId String AgreementId of document. You must specify this, DocumentIndex or DocumentId. yes


DocumentResponseModel
Name Type Description Optional
DocumentId Int Document Id. Use this id in the signers DocumentIds list. yes
Title String Document title. If not set, defaults to filename. yes
Filename String Document filename.
DocumentFormat String Document format. Currently the only allowed value is Pdf.
DocumentData String Base64 encoded document.
CustomData String Any custom data set for this document.



Download

Description

Download a initially uploaded version of a document. Specify either "DocumentIndex", "DocumentId" or "AgreementId", but only one of the values.

Synopsis

POST api.esignatur.dk/SourceDocument/Download

JSON Input

{
  "Id": "b2d79fcc-16db-43bb-848e-c8f3eb32ad12",
  "DocumentIndex": 0
}

JSON Input

{
  "Id": "b2d79fcc-16db-43bb-848e-c8f3eb32ad12",
  "DocumentId": 1
}

JSON Input

{
  "Id": "b2d79fcc-16db-43bb-848e-c8f3eb32ad12",
  "AgreementId": "568ee55aukPTqSy23393"
}

JSON Output

{
  "DocumentId": 1,
  "Title": "Contract 1",
  "Filename": "Contract1.pdf",
  "DocumentFormat": "Pdf",
  "DocumentData": "AAECAw==",
  "CustomData": ""
}