Download the tag -> original table of a pseudonymized document
download_correspondenceDownload the CSV correspondence table for a pseudonymized redacted PDF to map placeholders back to original text so names can be restored later; keep this re-identification file private.
Instructions
Download the correspondence table of a document redacted with mode "pseudonymize": one CSV row per tag (placeholder, the user's rename, category, original text), so the names can be restored later.
Only for pseudonymized documents with status "redacted"; a redact-mode document has no table. The table re-identifies the document: keep it with the user and never send it alongside the redacted PDF. It is written to a file on this machine. Never open or read that file: to put the names back into something you wrote, pass its path to restore_names.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| document_id | Yes | The document id, from the documents list of redact_pdf or get_job_status. | |
| output_path | No | Where to write the correspondence CSV on this machine. Defaults to "<document_id>-correspondence.csv" in the working directory. Never overwrites an existing file. |