DELETE

/Person

When to Use

Remove persons created with incorrect details
Clean up duplicate person records
Delete test persons from development environments

Prerequisites

Person must have no active business relationships
Understanding that deletion cascades to all associated addresses and communications

Considerations

Strict Business Rules: Only works when person has no BizEntityParty relationships or transaction history
Cascade Deletion: All associated Address and Communication records automatically removed
Irreversible Operation: Deletion is permanent with no recovery mechanism available
Compliance Audit: Deletion events logged for regulatory and audit purposes
SMSF Restrictions: Cannot delete persons involved in SMSF trustee relationships
Investment History: Any involvement in investments, distributions, or transactions prevents deletion

Description

Permanently deletes a person record and all associated Address and Communication records. This operation follows the 7G API specification constraint that person deletion is only permitted when no relationships exist beyond Address and Communication records.

Advanced Resource: Person records are typically managed through BizEntity operations. Use this endpoint for direct person deletion only when the person has no active business relationships or for pre-investment cleanup purposes.

7G API Deletion Rules

According to the official specification, the person DELETE endpoint will only work if:

No BizEntityParty relationships exist - Person cannot be linked to any BizEntity
Only Address and/or Communication records - These are automatically deleted
No transaction history exists - Any BizTransaction involvement prevents deletion

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
`PersonID` >	integer	> Conditional...	The 7G system identifier for the person to delete. Preferred for performance and direct system lookup.
`ExternalPersonId` >	string	> Conditional...	Your external identifier for the person to delete. Use when you cannot store 7G's native PersonID.

PersonID

integer

> Conditional...

The 7G system identifier for the person to delete. Preferred for performance and direct system lookup.

ExternalPersonId

string

> Conditional...

Your external identifier for the person to delete. Use when you cannot store 7G's native PersonID.

Safe Deletion Process

Verify person exists and you have the correct ID
Check person has no active BizEntity relationships
Confirm person has no transaction history
Execute deletion (addresses and communications removed automatically)

Example Requests

bash

# Delete person by PersonID (recommended for performance)
curl -X DELETE "https://api.7g.com.au/Person?PersonID=12345" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Delete person by ExternalPersonId (alternative identifier)
curl -X DELETE "https://api.7g.com.au/Person?ExternalPersonId=EXT-PERSON-001" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

Response Examples

json

{
  "result": true,
  "message": "Person deleted successfully",
  "recordCount": 0,
  "data": []
}