PUT
/address
Usage Notes
When
- Update address details (street, suburb, postcode, country)
- Change address type classification
- Correct address data for entity correspondence
Requirements
- AddressID or ExternalAddressId to identify the record
- Complete DTO required (retrieve current data via GET first)
Notes
- PUT replaces entire record - include all data to retain
- ExternalAddressId cannot be changed after creation
- Entity ownership cannot be transferred via PUT
Description
Updates an address record by complete replacement. Retrieve current data via GET, modify required fields, and submit the complete structure.
Required Headers - See Authentication
| Header | Value | Description |
|---|---|---|
| Authorization | {accessToken} | Bearer token for API access |
| Version | 2.0 | API version identifier |
| Content-Type | application/json | Content type for request body |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
AddressID |
integer | 7G platform identifier for address record to update. Cannot be changed - used only for record targeting. | |
externalAddressId |
string(50) | Optional |
Your external identifier for this address. Cannot be changed after creation. |
AddressTypeID |
integer | Classification of address type determining validation rules, AML/KYC compliance requirements, and correspondence routing. Updates to address type trigger re-validation of correspondence delivery systems and compliance reporting workflows. | |
aboveAddressLine |
string(200) | Optional |
Updated additional address information above the main address line (unit, suite, level, apartment, floor). Changes to this field trigger re-delivery of regulatory correspondence to ensure accurate routing. Updates propagate to investor distribution mailing systems and ASIC notification delivery workflows. |
addressLine |
string(200) | Optional |
Updated main street address line including street number and name. Modifications to primary address line trigger AML/KYC residential verification workflows and CRS/FATCA tax residency re-confirmation processes. Address line changes update across all compliance reporting systems immediately. |
suburb |
string(255) | Updated suburb, city, or town name. | |
postcode |
string(255) | Updated postal code for the address. | |
stateCode |
string(255) | Optional |
Updated Australian state or territory code using standard abbreviations (NSW, VIC, QLD, SA, WA, TAS, NT, ACT). State changes trigger state-level tax reporting updates for CRS/FATCA compliance, regulatory jurisdiction changes for financial services compliance, and postal delivery revalidation to ensure correspondence accuracy. |
countryCode |
string(255) | Updated country code (AU for Australia, follows ISO 3166-1 alpha-2 standard). | |
BizEntityID |
integer | Updates address linkage to business entity for ownership transfer or correspondence routing changes. Modifications affect investor correspondence delivery systems, CRS/FATCA tax reporting entity assignments, and AML/KYC verification ownership. | |
externalBizEntityId |
string(50) | Your external identifier for the business entity (alternative to bizEntityID for ownership transfer). | |
PersonID |
integer | Updates address linkage to individual person for ownership transfer or personal correspondence routing changes. Modifications affect individual trustee verification systems, person-specific AML/KYC records, and residential address validation. | |
externalPersonId |
string(50) | Your external identifier for the person (alternative to personID for ownership transfer). | |
OrganisationID |
integer | Updates address linkage to organisation for ownership transfer or corporate correspondence routing changes. Modifications affect corporate trustee verification systems, ASIC-registered entity records, and organisation-level compliance reporting. | |
externalOrganisationId |
string(50) | Your external identifier for the organisation (alternative to organisationID for ownership transfer). |
AddressID
7G platform identifier for address record to update. Cannot be changed - used only for record targeting.
externalAddressId
Your external identifier for this address. Cannot be changed after creation.
AddressTypeID
Classification of address type determining validation rules, AML/KYC compliance requirements, and correspondence routing. Updates to address type trigger re-validation of correspondence delivery systems and compliance reporting workflows.
aboveAddressLine
Updated additional address information above the main address line (unit, suite, level, apartment, floor). Changes to this field trigger re-delivery of regulatory correspondence to ensure accurate routing. Updates propagate to investor distribution mailing systems and ASIC notification delivery workflows.
addressLine
Updated main street address line including street number and name. Modifications to primary address line trigger AML/KYC residential verification workflows and CRS/FATCA tax residency re-confirmation processes. Address line changes update across all compliance reporting systems immediately.
suburb
Updated suburb, city, or town name.
postcode
Updated postal code for the address.
stateCode
Updated Australian state or territory code using standard abbreviations (NSW, VIC, QLD, SA, WA, TAS, NT, ACT). State changes trigger state-level tax reporting updates for CRS/FATCA compliance, regulatory jurisdiction changes for financial services compliance, and postal delivery revalidation to ensure correspondence accuracy.
countryCode
Updated country code (AU for Australia, follows ISO 3166-1 alpha-2 standard).
BizEntityID
Updates address linkage to business entity for ownership transfer or correspondence routing changes. Modifications affect investor correspondence delivery systems, CRS/FATCA tax reporting entity assignments, and AML/KYC verification ownership.
externalBizEntityId
Your external identifier for the business entity (alternative to bizEntityID for ownership transfer).
PersonID
Updates address linkage to individual person for ownership transfer or personal correspondence routing changes. Modifications affect individual trustee verification systems, person-specific AML/KYC records, and residential address validation.
externalPersonId
Your external identifier for the person (alternative to personID for ownership transfer).
OrganisationID
Updates address linkage to organisation for ownership transfer or corporate correspondence routing changes. Modifications affect corporate trustee verification systems, ASIC-registered entity records, and organisation-level compliance reporting.
externalOrganisationId
Your external identifier for the organisation (alternative to organisationID for ownership transfer).
Entity Ownership Transfer
To transfer address ownership, provide the new entity association:
- Clear current ownership by setting all entity IDs to null
- Set new owner using bizEntityID, personID, or organisationID
- Only one entity association is allowed per address
Important: Address ownership changes affect compliance reporting and correspondence routing.
Example Requests
bash
# Update address details
curl -X PUT "https://api.7g.com.au/address" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0" \
-H "Content-Type: application/json" \
-d '{
"addressID": 7001,
"externalAddressId": "EXT-ADDR-001",
"addressTypeID": 1,
"aboveAddressLine": "Unit 6",
"addressLine": "456 Collins Street",
"suburb": "Melbourne",
"postcode": "3000",
"stateCode": "VIC",
"countryCode": "AUS",
"bizEntityID": 12345
}'Response Examples
json
{
"result": true,
"message": "Address updated successfully",
"recordCount": 1,
"data": [
{
"addressID": 12345,
"externalAddressId": "RES-001",
"addressTypeID": 1,
"aboveAddressLine": "Unit 6",
"addressLine": "456 Collins Street",
"suburb": "Melbourne",
"postcode": "3000",
"stateCode": "VIC",
"countryCode": "AUS",
"bizEntityID": 789,
"externalBizEntityId": null,
"personID": null,
"externalPersonId": null,
"organisationID": null,
"externalOrganisationId": null
}
]
}