PUT

/Address

When to Use

  • Residential Relocation Updates: Update investor residential addresses after property moves while maintaining AML/KYC verification continuity
  • Address Type Reclassification: Change classification from residential to postal for distribution delivery optimization or business address designation
  • Ownership Transfer: Move address ownership from person-level to entity-level during corporate trustee appointments or organizational restructuring
  • Compliance Corrections: Fix address formatting to meet Australian postal standards for reliable regulatory correspondence delivery
  • CRS/FATCA Updates: Update country or state codes for accurate tax jurisdiction reporting and cross-border compliance requirements

Common Scenarios

  • Residential Move Update: Update investor residential address after property relocation while maintaining AML/KYC verification continuity and distribution delivery accuracy
  • Address Type Conversion: Change residential address to postal address for optimized correspondence delivery or reclassify business address after commercial premise relocation
  • Organizational Restructuring: Transfer address ownership from person to organisation during corporate trustee appointments or entity-level changes
  • Postal Format Corrections: Update address formatting to meet Australian postal standards for reliable ASIC notification and investor correspondence delivery
  • Tax Jurisdiction Updates: Modify country or state codes for accurate CRS/FATCA reporting after investor relocation or cross-border address changes

Prerequisites

  • Valid Bearer token with address update permissions
  • Address must exist (use addressID or externalAddressId to identify)
  • Target entity (if changing ownership) must exist
  • Understanding of exclusive ownership rules

Considerations

  • Complete Replacement: Provide all fields - missing fields may be cleared
  • Exclusive Ownership: Address can only belong to ONE entity at a time
  • External ID Immutability: externalAddressId cannot be changed after creation
  • Australian formatting validation enforced on updates

Description

Updates an existing address record with new information. This endpoint performs a complete replacement of the address data, so include all fields you want to retain.

Advanced Resource: Address records can be updated independently via this endpoint or managed through BizEntity operations. Use this endpoint for direct address modifications, ownership transfers, or compliance-driven corrections.

⚠️ Complete Replacement Pattern

This endpoint replaces the entire address record. Always retrieve the current address first, modify the required fields, then send the complete updated object.

Required Headers - See Authentication

HeaderValueDescription
Authorization{accessToken}Bearer token for API access
Version2.0API version identifier
Content-Typeapplication/jsonContent 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
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).

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

json
{
  "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
}

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
    }
  ]
}
GET Get Addresses POST Create Address DELETE Delete Address