documentRIDstringrequired
DeleteDocumentAsync
delete
/v1/documents/{documentRID}
Path Parameters
Response
Response
No Content
MergeFileAndUpdateDocument
post
/v1/documents/{documentRID}/merge
Path Parameters
documentRIDstringrequired
Body
Body
MergePayload
* Additional properties are NOT allowed.
mergeFieldDataobject | null
mergeFieldValuesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
mergeActionstring
Allowed values:MergeDataMergeVariableDataGenerateSignerFieldsMergeDataAndGenerateSignerFieldsMergeVariableDataAndGenerateSignerFields
Response
Response
Success
/v1/documents/{documentRID}/file/download
get
/v1/documents/{documentRID}/file/download
Path Parameters
documentRIDstringrequired
Response
application/json
Response
application/json
Success
DownloadSpecification
* Additional properties are NOT allowed.
metadataUrlstring | null
__typestring | null
idstring | null
urlstring | null(uri)
downloadTokenstring | null
prepareXmlInfostring | null
downloadUrlstring | null(uri)
downloadPrepStartURLstring | null(uri)
downloadPrepStatusURLstring | null(uri)
application/json
/v1/documents/{documentRID}/file/thumbnail
get
/v1/documents/{documentRID}/file/thumbnail
Path Parameters
documentRIDstringrequired
Response
Response
Success
GetDocumentTemplatesAsync
get
/v1/documentTemplates
Query Parameters
Takeinteger(int32)
>= 0<= 20
Searchstring
ContinuationTokenstring
Filtersstring
Response
application/json
Response
application/json
Success
DocumentTemplateSearchResponse
* Additional properties are NOT allowed.
itemsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
continuationTokenstring | null
application/json