Skip to main content
DELETE
Delete a regulatory report permanently.

​
What is deleted

The report, its copied narrative, reasons and other report fields, its links to transactions, and its generated goAML XML and PDF. Every stored version of those files is erased. The report disappears from report lists, and previously issued download URLs stop working. The case, transactions, people and companies are not deleted. The report does not take their data with it. Deletion is permanent and irreversible.

​
Confirmation

A draft or validated report is deleted without a request body. Deleting a finalized report requires an explicit confirmation:
Without it, a finalized report returns 400 and nothing is deleted.

​
If the files cannot be erased right now

A 503 with code: report_storage_unavailable means the report files could not be erased right now. The report is still in place, so repeat the request. A 409 with code: report_deletion_pending means a delete of this report is already under way: repeat the request to finish it.

​
Resolve a blocked deletion

If a person, company, transaction, case or session delete returns 409 with code: in_filed_report, the response names the reports that hold the data. Delete each report here, then repeat the blocked delete.

Authorizations

​
x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

​
organization_id
string<uuid>
required

Organization UUID.

​
application_id
string<uuid>
required

Application UUID.

​
report_uuid
string<uuid>
required

Report UUID.

Example:

"5ec00000-0000-4000-8000-000000000007"

Body

application/json

Required only for a finalized report.

​
confirm_delete
boolean

Set to true to confirm that a finalized report and its generated files are deleted permanently.

Response

Report deleted, including its generated files.