DELETE
/Document
Usage Notes
When
- Remove duplicate, obsolete, or incorrect document records
- Delete documents that no longer meet retention requirements
- Honor client requests for document removal
Requirements
- DocumentID or ExternalDocumentId must be provided
Notes
- Deletion is irreversible (document and file content cannot be recovered)
- Document immediately disappears from investor portals
- Ensure deletion complies with document retention requirements
Description
Permanently deletes a document record from the 7G system. Removes document metadata and portal associations.
Required Headers - See Authentication
| Header | Value | Description |
|---|---|---|
| Authorization | {accessToken} | Bearer token for API access |
| Version | 2.0 | API 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
The native 7G identifier for the document to delete. Preferred for better performance.
ExternalDocumentId
Your external system identifier for the document to delete. Alternative to DocumentID.
ProductID
Native 7G product identifier for enhanced security validation.
ExternalProductId
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
}