documentRIDstringrequired
PartialUpdateDocumentAsync
patch
/v1/documents/{documentRID}
Path Parameters
Body
application/json-patch+json
Body
application/json-patch+json
JsonPatchDocument
Array of operations to perform
opstring
valuestring | null
pathstring
Response
application/json
Response
application/json
Success
DocumentResponse
* Additional properties are NOT allowed.
ridstring | null
containerRIDstring | null
templateRIDstring | null
namestring | null
creatorobject
* Additional properties are NOT allowed.
Show Child Parameters
parentIdstring | null
accountIdstring | null
fileobject
* Additional properties are NOT allowed.
Show Child Parameters
rolesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
fieldsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
settingsobject
* Additional properties are NOT allowed.
Show Child Parameters
signatureSettingsobject
* Additional properties are NOT allowed.
Show Child Parameters
signerSequencingboolean | null
createdAtstring | null(date-time)
updatedAtstring | null(date-time)
variablesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
application/json
DeleteDocumentAsync
delete
/v1/documents/{documentRID}
Path Parameters
documentRIDstringrequired
Response
Response
No Content
MergeFileAndUpdateDocument
post
/v1/documents/{documentRID}/merge
Path Parameters
documentRIDstringrequired
Body
Body
MergePayload
* Additional properties are NOT allowed.
mergeFieldDataobject | null
mergeActionstring
Allowed values:MergeVariableDataGenerateSignerFieldsMergeVariableDataAndGenerateSignerFields
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