POST
/Address
When to Use
- Create addresses during investor onboarding
- Set up multiple address types (residential, postal, business)
- Add addresses for tax residency verification
- Bulk import addresses from legacy systems using external IDs
Prerequisites
- Target entity must exist before creating address
Considerations
- Each address must belong to exactly one entity
- Australian formatting required (valid state codes and postcodes)
- External IDs must be unique across the system
Description
Creates a new address record and associates it with an existing entity.
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 or bulk imports.
Address Types: Residential (primary residence), Postal (correspondence delivery), Business (commercial location). Refer to Common/Lookup (Category: AddressType) for current classifications.
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 | 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
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
Your unique identifier for this address. Must be unique across the entire system if provided.
AddressTypeID
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
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
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
Suburb, city, or town name.
postcode
Postal code for the address.
stateCode
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
Country code (AU for Australia, follows ISO 3166-1 alpha-2 standard).
BizEntityID
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
Your external identifier for the business entity (alternative to bizEntityID).
PersonID
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
Your external identifier for the person (alternative to personID).
OrganisationID
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
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
}
]
}