Sign in

v1

latestSwagger 2.02026-07-134026156.7 KB
PDF Submissions

Expire a PDF submission

Expiring a PDF submission deletes the PDF and removes the data from our database. This is useful for invalidating sensitive documents after they've been downloaded. You can also configure a data retention policy for your submissions so that they automatically expire.

delete/submissions/{submission_id}

Path parameters

submission_idstring required

Response

submission was expired

batch_idstring nullable required
editableboolean nullable required
error_messagestring nullable required
expiredboolean required
expires_atstring nullable required
idstring nullable required
json_schema_errorsstring[] nullable required
metadataobject required
passwordstring nullable required
processed_atstring nullable required
state'pending' | 'processed' | 'invalid_data' | 'error' | 'image_download_failed' | 'image_processing_failed' | 'waiting_for_data_requests' | 'syntax_error' | 'account_suspended' | 'license_revoked' | 'accidental' required
template_idstring nullable required
template_type'pdf' | 'html' required
template_versionstring nullable required
testboolean required
truncated_textobject nullable required
pdf_hashstring nullable required
download_urlstring nullable required
permanent_download_urlstring nullable required
preview_download_urlstring nullable required
preview_generated_atstring nullable required
audit_trail_download_urlstring nullable required