POST

/Address

When to Use

  • Investor Onboarding: Create residential addresses during initial BizEntity setup for AML/KYC verification and distribution delivery
  • Multi-Address Setup: Establish residential, postal, and business addresses for comprehensive investor contact management
  • CRS/FATCA Compliance: Add verified addresses for tax residency determination and regulatory jurisdiction reporting
  • Legacy System Migration: Bulk import addresses with ExternalAddressId for system transition tracking and dual-ID maintenance
  • Corporate Trustee Setup: Create organisation-level business addresses for ASIC-registered entity verification and corporate correspondence

Common Scenarios

  • New Investor Setup: Create residential address as part of BizEntity onboarding workflow for AML/KYC verification and distribution delivery
  • Multi-Address Configuration: Establish residential address for identity verification, postal address for correspondence, and business address for corporate operations
  • Corporate Trustee Establishment: Set up organisation-level business address for ASIC-registered entity verification and company secretary correspondence
  • External System Integration: Import addresses with ExternalAddressId to maintain dual-ID tracking for CRM synchronization and investor data migration
  • Compliance Documentation: Add verified residential addresses specifically for CRS/FATCA tax residency determination and AML/KYC identity confirmation

Prerequisites

  • Valid Bearer token with address creation permissions
  • Target entity must exist before creating address

Considerations

  • Exclusive Ownership: Each address must belong to exactly ONE entity
  • Australian formatting enforced - valid state codes and postcodes required
  • External IDs must be unique across the entire system
  • CRS/FATCA compliance requires accurate address information for tax reporting

Description

Creates a new address record and associates it with an existing entity. Addresses are essential for investor compliance, correspondence, and regulatory reporting requirements in the Australian financial services context.

Advanced Resource: Address records can be created independently via this endpoint or automatically as part of BizEntity operations. Use this endpoint for direct address management, bulk imports, or when synchronizing address data from external systems.

Address Classification

Address types determine validation rules, AML/KYC compliance requirements, and correspondence routing:

  • Residential Addresses: Primary residence for identity verification and AML/KYC compliance
  • Postal Addresses: Correspondence delivery location for regulatory notifications and investor communications
  • Business Addresses: Commercial location for corporate entity verification and business operations

Refer to Common/Lookup endpoint (Category: AddressType) for current type classifications.

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
Optional
7G platform identifier assigned upon successful creation. Must be explicitly set to 0 or null for POST operations to prevent update attempts. Referenced across platform for relationship linkage, compliance reporting (CRS/FATCA address verification), and audit trails.
externalAddressId
 string(50)
Optional
Your unique identifier for this address. Must be unique across the entire system if provided.
AddressTypeID >
integer
Classification of address type determining validation rules, AML/KYC compliance requirements, and correspondence routing. Residential addresses require full verification for identity confirmation, postal addresses validate delivery locations for regulatory notifications, and business addresses confirm commercial operations for entity verification.
aboveAddressLine
 string(200)
Optional
Additional address information above the main address line (unit, suite, level, apartment, floor). Critical for accurate delivery of regulatory correspondence, ASIC notifications, and distribution statements. Helps distinguish multiple entities at same building for AML/KYC verification and prevents mail routing errors in multi-occupancy properties.
addressLine
 string(200)
Optional
Main street address line including street number and name. Forms the primary physical location identifier for AML/KYC residential verification, regulatory correspondence delivery, and CRS/FATCA tax residency confirmation. Must be accurate for Australian address validation and postal delivery standards.
suburb >
string(255)
Suburb, city, or town name.
postcode >
string(255)
Postal code for the address.
stateCode
 string(255)
Optional
Australian state or territory code using standard abbreviations (NSW, VIC, QLD, SA, WA, TAS, NT, ACT). Required for domestic Australian addresses to support CRS/FATCA state-level tax reporting, compliance with state-based financial services regulations, and accurate postal delivery validation. Must correspond to postcode and suburb for address verification.
countryCode >
string(255)
Country code (AU for Australia, follows ISO 3166-1 alpha-2 standard).
BizEntityID >
integer
Links address to business entity for investor correspondence delivery, CRS/FATCA tax reporting, and AML/KYC residential verification. Use when address serves BizEntity-level operations (distribution mailings, regulatory notifications, investor communications).
externalBizEntityId >
string(50)
Your external identifier for the business entity (alternative to bizEntityID).
PersonID >
integer
Links address to individual person for personal correspondence, individual trustee verification, and person-specific AML/KYC address validation. Use when address is person-specific rather than entity-level (residential locations, personal contact points).
externalPersonId >
string(50)
Your external identifier for the person (alternative to personID).
OrganisationID >
integer
Links address to organisation for corporate correspondence, ASIC-registered entity verification, and organisation-level compliance reporting. Use when address serves organisational purposes (corporate trustee offices, company secretary locations, registered business premises).
externalOrganisationId >
string(50)
Your external identifier for the organisation (alternative to organisationID).
AddressID
integer
Optional
7G platform identifier assigned upon successful creation. Must be explicitly set to 0 or null for POST operations to prevent update attempts. Referenced across platform for relationship linkage, compliance reporting (CRS/FATCA address verification), and audit trails.
externalAddressId
string(50)
Optional
Your unique identifier for this address. Must be unique across the entire system if provided.
AddressTypeID
integer
Classification of address type determining validation rules, AML/KYC compliance requirements, and correspondence routing. Residential addresses require full verification for identity confirmation, postal addresses validate delivery locations for regulatory notifications, and business addresses confirm commercial operations for entity verification.
aboveAddressLine
string(200)
Optional
Additional address information above the main address line (unit, suite, level, apartment, floor). Critical for accurate delivery of regulatory correspondence, ASIC notifications, and distribution statements. Helps distinguish multiple entities at same building for AML/KYC verification and prevents mail routing errors in multi-occupancy properties.
addressLine
string(200)
Optional
Main street address line including street number and name. Forms the primary physical location identifier for AML/KYC residential verification, regulatory correspondence delivery, and CRS/FATCA tax residency confirmation. Must be accurate for Australian address validation and postal delivery standards.
suburb
string(255)
Suburb, city, or town name.
postcode
string(255)
Postal code for the address.
stateCode
string(255)
Optional
Australian state or territory code using standard abbreviations (NSW, VIC, QLD, SA, WA, TAS, NT, ACT). Required for domestic Australian addresses to support CRS/FATCA state-level tax reporting, compliance with state-based financial services regulations, and accurate postal delivery validation. Must correspond to postcode and suburb for address verification.
countryCode
string(255)
Country code (AU for Australia, follows ISO 3166-1 alpha-2 standard).
BizEntityID
integer
Links address to business entity for investor correspondence delivery, CRS/FATCA tax reporting, and AML/KYC residential verification. Use when address serves BizEntity-level operations (distribution mailings, regulatory notifications, investor communications).
externalBizEntityId
string(50)
Your external identifier for the business entity (alternative to bizEntityID).
PersonID
integer
Links address to individual person for personal correspondence, individual trustee verification, and person-specific AML/KYC address validation. Use when address is person-specific rather than entity-level (residential locations, personal contact points).
externalPersonId
string(50)
Your external identifier for the person (alternative to personID).
OrganisationID
integer
Links address to organisation for corporate correspondence, ASIC-registered entity verification, and organisation-level compliance reporting. Use when address serves organisational purposes (corporate trustee offices, company secretary locations, registered business premises).
externalOrganisationId
string(50)
Your external identifier for the organisation (alternative to organisationID).

Entity Ownership Rules

Each address must be associated with exactly one entity:

  • Provide bizEntityID OR externalBizEntityId for business entities
  • Provide personID OR externalPersonId for individuals
  • Provide organisationID OR externalOrganisationId for organisations
Important: Only one entity association is allowed per address. Multiple entity associations will result in an error.

Example Requests

json
{
  "externalAddressId": "RES-001",
  "addressTypeID": 1,
  "aboveAddressLine": "Unit 5",
  "addressLine": "123 Collins Street",
  "suburb": "Melbourne",
  "postcode": "3000",
  "stateCode": "VIC",
  "countryCode": "AUS",
  "bizEntityID": 789
}

Response Examples

json
{
  "result": true,
  "message": "Address created successfully",
  "recordCount": 1,
  "data": [
    {
      "addressID": 12345,
      "externalAddressId": "RES-001",
      "addressTypeID": 1,
      "aboveAddressLine": "Unit 5",
      "addressLine": "123 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 PUT Update Address DELETE Delete Address