DELETE
/Address
When to Use
- Permanently remove address records that are no longer valid
- Clean up duplicate or incorrect addresses
- Remove addresses before transferring ownership to different entities
- Comply with data retention policies
Common Scenarios
- Duplicate Address Removal: Clean up duplicate addresses created during data imports or manual entry errors
- Outdated Property Deletion: Remove addresses for properties that entities no longer own or occupy
- Test Data Cleanup: Delete test addresses created during system testing or training
- Privacy Compliance: Remove address records as part of data subject access requests or right to erasure
Prerequisites
- Valid Bearer token with address deletion permissions
- Address must exist and be accessible to your account
- Understanding of cascade deletion effects
Considerations
- Cascade Impact: Removes address from all associated compliance reports
- Irreversible: Deletion is permanent and cannot be undone
- Compliance Impact: May affect CRS/FATCA reporting for associated entities
- Alternative: Consider updating to different address type rather than deletion
Description
Permanently deletes an address record from the system. This removes the address association from any related entities and impacts compliance reporting.
Advanced Resource: Address records are typically managed through BizEntity operations. Use this endpoint for direct address deletion only when the address is no longer associated with active entities or for data cleanup purposes.
⚠️ Deletion Impact
Address deletion affects:
- Entity compliance reporting (CRS/FATCA)
- Correspondence routing and delivery
- Historical record keeping
- Regulatory audit trails
Recommended: Update address details rather than delete when possible.
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 |
---|---|---|---|
AddressID |
integer | The unique system identifier for the address record to delete. Provide this for direct deletion using the internal 7G ID. | |
ExternalAddressId |
string | Your external system identifier for the address record to delete. Use this when referencing addresses by your organization's ID system for cross-system consistency. |
AddressID
The unique system identifier for the address record to delete. Provide this for direct deletion using the internal 7G ID.
ExternalAddressId
Your external system identifier for the address record to delete. Use this when referencing addresses by your organization's ID system for cross-system consistency.
Example Requests
bash
# Delete address by native ID
curl -X DELETE "https://api.7g.com.au/Address?AddressID=12345" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"
# Delete address by external ID
curl -X DELETE "https://api.7g.com.au/Address?ExternalAddressId=RES-001" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"
Response Examples
json
{
"result": true,
"message": "Address deleted successfully",
"recordCount": 0,
"data": null
}