GET

/Address

When to Use

Verify addresses before mailing distribution statements
Retrieve address details for identity verification
Access addresses for tax residency determination
Look up addresses using external IDs for CRM integration

Prerequisites

Either AddressID or ExternalAddressId to identify the record

Considerations

Retrieves one address record at a time
Each address belongs to one entity (BizEntity, Person, or Organisation)
Native IDs (AddressID) provide better performance than external IDs

Description

Retrieves a single address record by its unique identifier.

Advanced Resource: Address records are typically managed through BizEntity operations, but can be accessed independently via this endpoint.

Address Types: Residential, Postal, Business. Refer to Common/Lookup (Category: AddressType) for classifications.

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
  }
}