GET

/Address

When to Use

Pre-Mailing Validation: Verify investor residential addresses before distribution statement mailings to prevent delivery failures
AML/KYC Verification: Retrieve address details for identity verification workflows and residential confirmation requirements
CRS/FATCA Reporting: Access address records for tax residency determination and regulatory jurisdiction reporting
External System Synchronization: Look up addresses using ExternalAddressId for CRM integration and investor data management
Compliance Document Delivery: Validate postal addresses before sending ASIC notifications and regulatory correspondence

Common Scenarios

Single Record Lookup: Use AddressID for direct access to specific address details before distribution statement mailings or regulatory notifications
External Integration: Use ExternalAddressId when synchronizing investor addresses with external CRM systems or identity management platforms
Pre-Mailing Verification: Retrieve address details to validate Australian postal formatting before sending ASIC notifications or investor correspondence
AML/KYC Validation: Access residential address records for identity verification workflows and compliance documentation
CRS/FATCA Reporting: Retrieve address details for tax jurisdiction determination and cross-border reporting requirements

Prerequisites

Valid Bearer token with address read permissions
Either AddressID or ExternalAddressId to identify the record
Understanding of address type classifications and their compliance implications

Considerations

Single Record Only: This endpoint retrieves one address record at a time
Exclusive Ownership: Each address record can belong to ONE BizEntity, Person, or Organisation (not multiple)
Native IDs (AddressID) provide better performance than external IDs
Australian address formatting with validated state codes and postcodes

Description

Retrieves a single address record by its unique identifier. Returns complete address information including type classification, Australian-formatted location details, and the entity it belongs to.

Advanced Resource: Address records are typically created and managed through BizEntity operations, but can be accessed independently via this endpoint for verification, synchronization, or compliance purposes.

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.

Entity Relationships

An address record will belong to exactly one of the following:

BizEntity (via BizEntityID)
Person (via PersonID)
Organisation (via OrganisationID)

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
`AddressID` >	integer	> Conditional...	The unique system identifier for the address record. Provide this to retrieve a specific address by its internal ID.
`ExternalAddressId` >	string	> Conditional...	The external system identifier for the address record. Use this when integrating with external systems that maintain their own ID references.

AddressID

integer

> Conditional...

The unique system identifier for the address record. Provide this to retrieve a specific address by its internal ID.

ExternalAddressId

string

> Conditional...

The external system identifier for the address record. Use this when integrating with external systems that maintain their own ID references.

Example Requests

bash

# Get an address record by internal ID
curl -X GET https://api.7g.com.au/Address?AddressID=12345 \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Get an address record by external ID
curl -X GET "https://api.7g.com.au/Address?ExternalAddressId=EXT-ADDR-001" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

Response Examples

json

{
  "result": true,
  "message": null,
  "recordCount": 1,
  "data": {
    "addressID": 12345,
    "externalAddressId": "EXT-ADDR-001",
    "addressTypeID": 1,
    "aboveAddressLine": "Unit 5",
    "addressLine": "123 Collins Street",
    "suburb": "Melbourne",
    "postcode": "3000",
    "stateCode": "VIC",
    "countryCode": "AUS",
    "bizEntityID": 789,
    "externalBizEntityId": "EXT-BIZ-456",
    "personID": null,
    "externalPersonId": null,
    "organisationID": null,
    "externalOrganisationId": null
  }
}