ResiBizDetect API Documentation

Introduction

The ResiBizDetect API provides information about residential addresses and whether they have an active business. This API is useful for verifying whether a residential address is associated with a business or not. The service is available under the Enterprise plan.


Supported Plans:

Enterprise

GET 
https://api.addresser.com.au/resibizdetect
Example Usage
https://api.addresser.com.au/resibizdetect?dpid=49327499

Request Headers

Field Type Description
x-api-key String

Your unique API key for authentication.

Important Note:

You can only provide either dpid or gnaf_address_detail_pid in the request. Both parameters cannot be included in the same request.

Parameter

Field Type Description
dpid String

Delivery Point Identifier, used to specify the address.
gnaf_address_detail_pid String

GNAF Address Detail PID, used to specify the address.

Response

200 Success Response Structure


{
    "FULL_ADDRESS": "U 2 14 STATION ST E HARRIS PARK NSW 2150",
    "DELIVY_POINT_ID": 88714076,
    "GNAF_ADDRESS_DETAIL_PID": "GANSW717606069",
    "RESIDENTIAL_ADDRESS_HAS_ACTIVE_BUSINESS": true,
    "PROPERTY_TYPE": "RESIDENTIAL",
    "BUSINESS_IN_RESINDENTIAL_CONFIDENCE_SCORE": "100%",
    "BUSINESS_IN_NON_RESIDENTIAL_CONFIDENCE_SCORE": "0%"
}

API Errors

              {
                "errorCode": 4073,
                "errorMessage": "Both dpid and gnaf_address_detail_pid cannot be provided."
              }
Error Code Error Message Description Resolution
4073

Both dpid and gnaf_address_detail_pid cannot be provided.

Both parameters were included in the request, which is not allowed.

Provide only one of dpid or gnaf_address_detail_pid.
4076

API key is missing or invalid.

The provided API key is either missing or invalid.

Ensure that a valid x-api-key header is provided.
4073

Supplied identifier is invalid.

The provided dpid or gnaf_address_detail_pid is invalid.

Ensure that the identifier is correct and exists.

Response Specification

Field Type Description Example
FULL_ADDRESS String

The full address of the location.

 "U 2 14 STATION ST E HARRIS PARK NSW 2150"
DELIVY_POINT_ID Integer

The unique identifier for the delivery point. (if available).

 88714076
GNAF_ADDRESS_DETAIL_PID String

The GNAF Address Detail PID (if available).

 "GANSW717606069"
RESIDENTIAL_ADDRESS_HAS_ACTIVE_BUSINESS Boolean

Whether the address has an active business at this location.

 true
PROPERTY_TYPE String

The type of property (e.g., "RESIDENTIAL").

 "RESIDENTIAL"
BUSINESS_IN_RESINDENTIAL_CONFIDENCE_SCORE String

Confidence score for business presence in residential locations.

 "100%"
BUSINESS_IN_NON_RESIDENTIAL_CONFIDENCE_SCORE String

Confidence score for business presence in non-residential locations.

 "0%"