Once a transaction is cancelled
, expired
, completed
or archived
you can prevent documents download. In this case, concerned documents can no longer be downloaded.
There are two ways to prevent download of a document:
- via the
/transactions
endpoint (immediately after the transaction iscancelled
,expired
,completed
). - via the
/archives
endpoint (at any time, once the transaction isarchived
).
Note that you must prevent documents download individually.
Note that when you prevent documents download from a completed
transaction, documents download will also be prevented from its archive
, and vice versa.
Via the /transactions endpoint
Send your request to POST /v1/transactions/{transaction_id}/documents/{document_id}/revoke-download
.
curl
https://api.universign.com/v1/transactions/tx_DwYGle91EQZA/documents/doc_6Amd/revoke-download
Via the /archives endpoint
Send your request to POST /v1/archives/{transaction_id}/documents/{document_id}/revoke-download
.
curl
https://api.universign.com/v1/archives/tx_DwYGle91EQZA/documents/doc_6Amd/revoke-download