DELETE

/Document

When to Use

Document Removal - Use this endpoint to permanently delete document records. Essential for:

  • Data Cleanup: Removing duplicate, obsolete, or incorrect document records
  • Compliance Management: Deleting documents that no longer meet retention requirements
  • Privacy Rights: Honoring client requests for document removal under privacy legislation
  • System Maintenance: Removing test documents or temporary files to optimize storage

Common Scenarios

  • Document Correction: Delete incorrect documents before uploading corrected versions
  • Retention Policy: Remove documents that have exceeded their retention period
  • Client Request: Delete personal documents at client's explicit request
  • Data Migration: Clean up duplicate records during system migrations

Prerequisites

  • Authentication: Valid Bearer token with document deletion permissions
  • Document Identification: Either DocumentID or ExternalDocumentId must be provided
  • Access Rights: User must have permission to delete the specified document

Considerations

  • Permanent Operation: Deletion is irreversible - document and file content cannot be recovered
  • Metadata Only: Deletes document record - associated files may need separate deletion via /Document/File
  • Audit Logging: Deletion events are typically logged for compliance tracking
  • Portal Impact: Document immediately disappears from investor portals
  • Regulatory Compliance: Ensure deletion complies with document retention requirements

Description

Permanently deletes a document record from the 7G system. This removes the document metadata and any portal associations. The document will no longer be accessible through the API or investor portals.

Required Headers - See Authentication

HeaderValueDescription
Authorization{accessToken}Bearer token for API access
Version2.0API version identifier

Query Parameters

Parameter Type Required Description
DocumentID >
integer
The native 7G identifier for the document to delete. Preferred for better performance.
ExternalDocumentId >
string
Your external system identifier for the document to delete. Alternative to DocumentID.
ProductID >
integer
Native 7G product identifier for enhanced security validation.
ExternalProductId >
string
Client-supplied product reference for enhanced security validation.
DocumentID
integer
The native 7G identifier for the document to delete. Preferred for better performance.
ExternalDocumentId
string
Your external system identifier for the document to delete. Alternative to DocumentID.
ProductID
integer
Native 7G product identifier for enhanced security validation.
ExternalProductId
string
Client-supplied product reference for enhanced security validation.

Example Requests

bash
# Delete document by native ID with security validation
curl -X DELETE "https://api.7g.com.au/Document?DocumentID=12347&ProductID=100" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Delete document by external ID with external product validation
curl -X DELETE "https://api.7g.com.au/Document?ExternalDocumentId=STMT_2024_Q1_001&ExternalProductId=FUND-001" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

Response Examples

json
{
  "result": true,
  "message": "Document successfully deleted",
  "data": null
}
GET Retrieve document metadata POST Create document record PUT Update document metadata GET /Document/File - Download file content