Get Service Point Detail V1

This page documents version 1 of the Get Service Point Detail endpoint.

Data Holders can retire this version after March 16th 2026. Data Recipients must update to newer versions prior to this date.

Get Service Point Detail

Code samples

GET https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints/{servicePointId} HTTP/1.1
Host: mtls.dh.example.com
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'
};

fetch('https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints/{servicePointId}', {
  method: 'GET',
  headers: headers
}).then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /energy/electricity/servicepoints/{servicePointId}

Obtain detailed standing information for a specific service point that is owned by the customer that has authorised the current session.

Endpoint Version


Version	1

Parameters

Name	In	Type	Required	Description
servicePointId	path	EnergyServicePointId	mandatory	The servicePointId to obtain data for. servicePointId values are returned by service point list endpoints. Note that it is not a nationalMeteringId.
x-v	header	string	mandatory	Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the endpoint MUST respond with a `406 Not Acceptable`. See HTTP Headers.
x-min-v	header	string	optional	Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the endpoint MUST respond with a `406 Not Acceptable`.
x-fapi-interaction-id	header	string	optional	An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date	header	string	conditional	The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address	header	string	optional	The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers	header	Base64	conditional	The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

200 Response

{
  "data": {
    "servicePointId": "string",
    "nationalMeteringId": "string",
    "servicePointClassification": "EXTERNAL_PROFILE",
    "servicePointStatus": "ACTIVE",
    "jurisdictionCode": "ALL",
    "isGenerator": false,
    "validFromDate": "string",
    "lastUpdateDateTime": "string",
    "consumerProfile": {
      "classification": "BUSINESS",
      "threshold": "LOW"
    },
    "distributionLossFactor": {
      "code": "string",
      "description": "string",
      "lossValue": "string"
    },
    "relatedParticipants": [
      {
        "party": "string",
        "role": "FRMP"
      }
    ],
    "location": {
      "addressUType": "paf",
      "simple": {
        "mailingName": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "postcode": "string",
        "city": "string",
        "state": "string",
        "country": "AUS"
      },
      "paf": {
        "dpid": "string",
        "thoroughfareNumber1": 0,
        "thoroughfareNumber1Suffix": "string",
        "thoroughfareNumber2": 0,
        "thoroughfareNumber2Suffix": "string",
        "flatUnitType": "string",
        "flatUnitNumber": "string",
        "floorLevelType": "string",
        "floorLevelNumber": "string",
        "lotNumber": "string",
        "buildingName1": "string",
        "buildingName2": "string",
        "streetName": "string",
        "streetType": "string",
        "streetSuffix": "string",
        "postalDeliveryType": "string",
        "postalDeliveryNumber": 0,
        "postalDeliveryNumberPrefix": "string",
        "postalDeliveryNumberSuffix": "string",
        "localityName": "string",
        "postcode": "string",
        "state": "string"
      }
    },
    "meters": [
      {
        "meterId": "string",
        "specifications": {
          "status": "CURRENT",
          "installationType": "BASIC",
          "manufacturer": "string",
          "model": "string",
          "readType": "string",
          "nextScheduledReadDate": "string"
        },
        "registers": [
          {
            "registerId": "string",
            "registerSuffix": "string",
            "averagedDailyLoad": 0,
            "registerConsumptionType": "INTERVAL",
            "networkTariffCode": "string",
            "unitOfMeasure": "string",
            "timeOfDay": "ALLDAY",
            "multiplier": 0,
            "controlledLoad": true,
            "consumptionType": "ACTUAL"
          }
        ]
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	EnergyServicePointDetailResponse
400	Bad Request	The following error codes MUST be supported: 400 - Invalid Field 400 - Missing Required Field 400 - Invalid Version	ResponseErrorListV2
404	Not Found	The following error codes MUST be supported: 404 - Unavailable Service Point 404 - Invalid Service Point	ResponseErrorListV2
406	Not Acceptable	The following error codes MUST be supported: 406 - Unsupported Version	ResponseErrorListV2

Response Headers

Status	Header	Type	Required	Description
200	x-v	string	mandatory	The payload version that the endpoint has responded with.
200	x-fapi-interaction-id	string	mandatory	An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400	x-fapi-interaction-id	string	mandatory	An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404	x-fapi-interaction-id	string	mandatory	An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406	x-fapi-interaction-id	string	mandatory	An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.

Schemas

EnergyServicePointDetailResponse

{
  "data": {
    "servicePointId": "string",
    "nationalMeteringId": "string",
    "servicePointClassification": "EXTERNAL_PROFILE",
    "servicePointStatus": "ACTIVE",
    "jurisdictionCode": "ALL",
    "isGenerator": false,
    "validFromDate": "string",
    "lastUpdateDateTime": "string",
    "consumerProfile": {
      "classification": "BUSINESS",
      "threshold": "LOW"
    },
    "distributionLossFactor": {
      "code": "string",
      "description": "string",
      "lossValue": "string"
    },
    "relatedParticipants": [
      {
        "party": "string",
        "role": "FRMP"
      }
    ],
    "location": {
      "addressUType": "paf",
      "simple": {
        "mailingName": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "postcode": "string",
        "city": "string",
        "state": "string",
        "country": "AUS"
      },
      "paf": {
        "dpid": "string",
        "thoroughfareNumber1": 0,
        "thoroughfareNumber1Suffix": "string",
        "thoroughfareNumber2": 0,
        "thoroughfareNumber2Suffix": "string",
        "flatUnitType": "string",
        "flatUnitNumber": "string",
        "floorLevelType": "string",
        "floorLevelNumber": "string",
        "lotNumber": "string",
        "buildingName1": "string",
        "buildingName2": "string",
        "streetName": "string",
        "streetType": "string",
        "streetSuffix": "string",
        "postalDeliveryType": "string",
        "postalDeliveryNumber": 0,
        "postalDeliveryNumberPrefix": "string",
        "postalDeliveryNumberSuffix": "string",
        "localityName": "string",
        "postcode": "string",
        "state": "string"
      }
    },
    "meters": [
      {
        "meterId": "string",
        "specifications": {
          "status": "CURRENT",
          "installationType": "BASIC",
          "manufacturer": "string",
          "model": "string",
          "readType": "string",
          "nextScheduledReadDate": "string"
        },
        "registers": [
          {
            "registerId": "string",
            "registerSuffix": "string",
            "averagedDailyLoad": 0,
            "registerConsumptionType": "INTERVAL",
            "networkTariffCode": "string",
            "unitOfMeasure": "string",
            "timeOfDay": "ALLDAY",
            "multiplier": 0,
            "controlledLoad": true,
            "consumptionType": "ACTUAL"
          }
        ]
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name	Type	Required	Description
data	EnergyServicePointDetail	mandatory	none
links	Links	mandatory	none
meta	Meta	optional	none

EnergyServicePointDetail

{
  "servicePointId": "string",
  "nationalMeteringId": "string",
  "servicePointClassification": "EXTERNAL_PROFILE",
  "servicePointStatus": "ACTIVE",
  "jurisdictionCode": "ALL",
  "isGenerator": false,
  "validFromDate": "string",
  "lastUpdateDateTime": "string",
  "consumerProfile": {
    "classification": "BUSINESS",
    "threshold": "LOW"
  },
  "distributionLossFactor": {
    "code": "string",
    "description": "string",
    "lossValue": "string"
  },
  "relatedParticipants": [
    {
      "party": "string",
      "role": "FRMP"
    }
  ],
  "location": {
    "addressUType": "paf",
    "simple": {
      "mailingName": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "postcode": "string",
      "city": "string",
      "state": "string",
      "country": "AUS"
    },
    "paf": {
      "dpid": "string",
      "thoroughfareNumber1": 0,
      "thoroughfareNumber1Suffix": "string",
      "thoroughfareNumber2": 0,
      "thoroughfareNumber2Suffix": "string",
      "flatUnitType": "string",
      "flatUnitNumber": "string",
      "floorLevelType": "string",
      "floorLevelNumber": "string",
      "lotNumber": "string",
      "buildingName1": "string",
      "buildingName2": "string",
      "streetName": "string",
      "streetType": "string",
      "streetSuffix": "string",
      "postalDeliveryType": "string",
      "postalDeliveryNumber": 0,
      "postalDeliveryNumberPrefix": "string",
      "postalDeliveryNumberSuffix": "string",
      "localityName": "string",
      "postcode": "string",
      "state": "string"
    }
  },
  "meters": [
    {
      "meterId": "string",
      "specifications": {
        "status": "CURRENT",
        "installationType": "BASIC",
        "manufacturer": "string",
        "model": "string",
        "readType": "string",
        "nextScheduledReadDate": "string"
      },
      "registers": [
        {
          "registerId": "string",
          "registerSuffix": "string",
          "averagedDailyLoad": 0,
          "registerConsumptionType": "INTERVAL",
          "networkTariffCode": "string",
          "unitOfMeasure": "string",
          "timeOfDay": "ALLDAY",
          "multiplier": 0,
          "controlledLoad": true,
          "consumptionType": "ACTUAL"
        }
      ]
    }
  ]
}

Properties

allOf

Name	Type	Required	Default	Description
anonymous	EnergyServicePoint	mandatory		none

and

Name	Type	Required	Description
anonymous	object	mandatory	none
» distributionLossFactor	object	mandatory	none
»» code	string	mandatory	A code used to identify data loss factor for the service point values. Refer to AEMO distribution loss factor documents for each financial year to interpret.
»» description	string	mandatory	Description of the data loss factor code and value.
»» lossValue	string	mandatory	The value associated with the loss factor code.
» relatedParticipants	[object]	mandatory	none
»» party	string	mandatory	The name of the party/organisation related to this service point.
»» role	Enum	mandatory	The role performed by this participant in relation to the service point. Note the details of enumeration values below: `FRMP`: Financially Responsible Market Participant `LNSP`: Local Network Service Provider or Embedded Network Manager for child connection points `DRSP`: wholesale Demand Response and/or market ancillary Service Provider and note that where it is not relevant for a NMI it will not be included.
» location	CommonPhysicalAddress	mandatory	Location of the servicepoint.
» meters	[object]	optional	The meters associated with the service point. This may be empty where there are no meters physically installed at the service point.
»» meterId	string	mandatory	The meter ID uniquely identifies a meter for a given service point. It is unique in the context of the service point. It is not globally unique.
»» specifications	object	mandatory	Technical characteristics of the meter.
»»» status	Enum	mandatory	A code to denote the status of the meter. Note the details of enumeration values below: `CURRENT`: Applies when a meter is current and not disconnected `DISCONNECTED`: Applies when a meter is present but has been remotely disconnected.
»»» installationType	Enum	mandatory	The metering Installation type code indicates whether the metering installation has to be manually read. Note the details of enumeration values below: `BASIC`: Accumulation Meter – Type 6 `COMMS1`: Interval Meter with communications – Type 1 `COMMS2`: Interval Meter with communications – Type 2 `COMMS3`: Interval Meter with communications – Type 3 `COMMS4`: Interval Meter with communications – Type 4 `COMMS4C`: CT connected metering installation that meets the minimum services specifications `COMMS4D`: Whole current metering installation that meets the minimum services specifications `MRAM`: Small customer metering installation – Type 4A `MRIM`: Manually Read Interval Meter – Type 5 `UMCP`: Unmetered Supply – Type 7 `VICAMI`: A relevant metering installation as defined in clause 9.9C of the NER `NCONUML`: Non-contestable unmeter load - Introduced as part of Global Settlement.
»»» manufacturer	string	optional	Free text field to identify the manufacturer of the installed meter.
»»» model	string	optional	Free text field to identify the meter manufacturer's designation for the meter model.
»»» readType	string	optional	Code to denote the method and frequency of Meter Reading. The value is formatted as follows: First Character = Remote (`R`) or Manual (`M`) Second Character = Mode: `T` = telephone, `W` = wireless, `P` = powerline, `I` = infra-red, `G` = galvanic, `V` = visual Third Character = Frequency of Scheduled Meter Readings: `1` = Twelve times per year, `2` = Six times per year, `3` = Four times per year, `D` = Daily or weekly Optional Fourth Character = to identify what interval length the meter is capable of reading. This includes five, 15 and 30 minute granularity as the following: `A` = 5 minute, `B` = 15 minute, `C` = 30 minute, `D` = Cannot convert to 5 minute (i.e. due to metering installation de-energised), `M` = Manually Read Accumulation Meter. For example, `MV3` = Manual, Visual, Quarterly `MV3M` = Manual, Visual, Quarterly, Manually Read Accumulation Meter `RWDC` = Remote, Wireless, Daily, 30 minutes interval.
»»» nextScheduledReadDate	DateString	optional	This date is the next scheduled meter read date (NSRD) if a manual Meter Reading is required.
»» registers	[object]	optional	Usage data registers available from the meter. This may be empty where there are no meters physically installed at the service point.
»»» registerId	string	mandatory	Unique identifier of the register within this service point. Is not globally unique.
»»» registerSuffix	string	optional	Register suffix of the meter register where the meter reads are obtained.
»»» averagedDailyLoad	number	optional	The energy delivered through a connection point or metering point over an extended period normalised to a 'per day' basis (kWh). This value is calculated annually.
»»» registerConsumptionType	Enum	mandatory	Indicates the consumption type of register.
»»» networkTariffCode	string	optional	The Network Tariff Code is a free text field containing a code supplied and published by the local network service provider.
»»» unitOfMeasure	string	optional	The unit of measure for data held in this register.
»»» timeOfDay	Enum	optional	Code to identify the time validity of register contents.
»»» multiplier	number	optional	Multiplier required to take a register value and turn it into a value representing billable energy.
»»» controlledLoad	Boolean	optional	Indicates whether the energy recorded by this register is created under a Controlled Load regime.
»»» consumptionType	Enum	optional	Actual/Subtractive Indicator. Note the details of enumeration values below: `ACTUAL`: implies volume of energy actually metered between two dates `CUMULATIVE`: indicates a meter reading for a specific date. A second Meter Reading is required to determine the consumption between those two Meter Reading dates.

Enumerated Values

Property	Value
role	FRMP
role	LNSP
role	DRSP
status	CURRENT
status	DISCONNECTED
installationType	BASIC
installationType	COMMS1
installationType	COMMS2
installationType	COMMS3
installationType	COMMS4
installationType	COMMS4C
installationType	COMMS4D
installationType	MRAM
installationType	MRIM
installationType	PROF
installationType	SAMPLE
installationType	UMCP
installationType	VICAMI
installationType	NCOLNUML
registerConsumptionType	INTERVAL
registerConsumptionType	BASIC
registerConsumptionType	PROFILE_DATA
registerConsumptionType	ACTIVE_IMPORT
registerConsumptionType	ACTIVE
registerConsumptionType	REACTIVE_IMPORT
registerConsumptionType	REACTIVE
timeOfDay	ALLDAY
timeOfDay	INTERVAL
timeOfDay	PEAK
timeOfDay	BUSINESS
timeOfDay	SHOULDER
timeOfDay	EVENING
timeOfDay	OFFPEAK
timeOfDay	CONTROLLED
timeOfDay	DEMAND
consumptionType	ACTUAL
consumptionType	CUMULATIVE

EnergyServicePoint

{
  "servicePointId": "string",
  "nationalMeteringId": "string",
  "servicePointClassification": "EXTERNAL_PROFILE",
  "servicePointStatus": "ACTIVE",
  "jurisdictionCode": "ALL",
  "isGenerator": false,
  "validFromDate": "string",
  "lastUpdateDateTime": "string",
  "consumerProfile": {
    "classification": "BUSINESS",
    "threshold": "LOW"
  }
}

Properties

Name	Type	Required	Default	Description
servicePointId	EnergyServicePointId	mandatory		Unique identifier for the service point.
nationalMeteringId	string	mandatory		The independent ID of the service point, known in the industry as the NMI.
servicePointClassification	Enum	mandatory		The classification of the service point as defined in MSATS procedures.
servicePointStatus	Enum	mandatory		Code used to indicate the status of the service point. Note the details for the enumeration values below: `ACTIVE`: An active, energised, service point `DE_ENERGISED`: The service point exists but is deenergised `EXTINCT`: The service point has been permanently decommissioned `GREENFIELD`: Applies to a service point that has never been energised `OFF_MARKET`: Applies when the service point is no longer settled in the NEM.
jurisdictionCode	Enum	mandatory		Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below: `ALL`: All Jurisdictions `ACT`: Australian Capital Territory `NEM`: National Electricity Market `NSW`: New South Wales `QLD`: Queensland `SA`: South Australia `TAS`: Tasmania `VIC`: Victoria.
isGenerator	Boolean	optional	`false`	This flag determines whether the energy at this connection point is to be treated as consumer load or as a generating unit (this may include generator auxiliary loads). If absent defaults to `false`. Note: Only applicable for scheduled or semischeduled generators, does not indicate on site generation by consumer.
validFromDate	DateString	mandatory		The latest start date from which the constituent data sets of this service point became valid.
lastUpdateDateTime	DateTimeString	mandatory		The date and time that the information for this service point was modified.
consumerProfile	object	optional		none
» classification	Enum	optional		A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments.
» threshold	Enum	optional		A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below: `LOW`: Consumption is less than the 'lower consumption threshold' as defined in the National Energy Retail Regulations `MEDIUM`: Consumption is equal to or greater than the 'lower consumption threshold', but less than the 'upper consumption threshold', as defined in the National Energy Retail Regulations `HIGH`: Consumption is equal to or greater than the 'upper consumption threshold' as defined in the National Energy Retail Regulations.

Enumerated Values

Property	Value
servicePointClassification	EXTERNAL_PROFILE
servicePointClassification	GENERATOR
servicePointClassification	LARGE
servicePointClassification	SMALL
servicePointClassification	WHOLESALE
servicePointClassification	NON_CONTEST_UNMETERED_LOAD
servicePointClassification	NON_REGISTERED_EMBEDDED_GENERATOR
servicePointClassification	DISTRIBUTION_WHOLESALE
servicePointStatus	ACTIVE
servicePointStatus	DE_ENERGISED
servicePointStatus	EXTINCT
servicePointStatus	GREENFIELD
servicePointStatus	OFF_MARKET
jurisdictionCode	ALL
jurisdictionCode	ACT
jurisdictionCode	NEM
jurisdictionCode	NSW
jurisdictionCode	QLD
jurisdictionCode	SA
jurisdictionCode	TAS
jurisdictionCode	VIC
classification	BUSINESS
classification	RESIDENTIAL
threshold	LOW
threshold	MEDIUM
threshold	HIGH

EnergyServicePointId

"string"

A unique identifier for an Energy service point, generated according to CDR ID Permanence requirements.

Properties

Name	Type	Required	Default	Description
anonymous	ASCIIString	mandatory		A unique identifier for an Energy service point, generated according to CDR ID Permanence requirements.

CommonPhysicalAddress

{
  "addressUType": "paf",
  "simple": {
    "mailingName": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "postcode": "string",
    "city": "string",
    "state": "string",
    "country": "AUS"
  },
  "paf": {
    "dpid": "string",
    "thoroughfareNumber1": 0,
    "thoroughfareNumber1Suffix": "string",
    "thoroughfareNumber2": 0,
    "thoroughfareNumber2Suffix": "string",
    "flatUnitType": "string",
    "flatUnitNumber": "string",
    "floorLevelType": "string",
    "floorLevelNumber": "string",
    "lotNumber": "string",
    "buildingName1": "string",
    "buildingName2": "string",
    "streetName": "string",
    "streetType": "string",
    "streetSuffix": "string",
    "postalDeliveryType": "string",
    "postalDeliveryNumber": 0,
    "postalDeliveryNumberPrefix": "string",
    "postalDeliveryNumberSuffix": "string",
    "localityName": "string",
    "postcode": "string",
    "state": "string"
  }
}

Properties

Name	Type	Required	Description
addressUType	Enum	mandatory	The type of address object present.
simple	CommonSimpleAddress	conditional	Required if addressUType is set to `simple`.
paf	CommonPAFAddress	conditional	Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to `paf`.

Enumerated Values

Property	Value
addressUType	paf
addressUType	simple

CommonSimpleAddress

{
  "mailingName": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "postcode": "string",
  "city": "string",
  "state": "string",
  "country": "AUS"
}

Required if addressUType is set to simple.

Properties

Name	Type	Required	Default	Description
mailingName	string	optional		Name of the individual or business formatted for inclusion in an address used for physical mail.
addressLine1	string	mandatory		First line of the standard address object.
addressLine2	string	optional		Second line of the standard address object.
addressLine3	string	optional		Third line of the standard address object.
postcode	string	conditional		Mandatory for Australian addresses.
city	string	mandatory		Name of the city or locality.
state	string	mandatory		Free text if the country is not Australia. If country is Australia then must be one of the values defined by the State Type Abbreviation in the PAF file format. `NSW`, `QLD`, `VIC`, `NT`, `WA`, `SA`, `TAS`, `ACT`, `AAT`.
country	ExternalRef	optional	`AUS`	A valid ISO 3166 Alpha-3 country code. Australia (`AUS`) is assumed if country is not present.

CommonPAFAddress

{
  "dpid": "string",
  "thoroughfareNumber1": 0,
  "thoroughfareNumber1Suffix": "string",
  "thoroughfareNumber2": 0,
  "thoroughfareNumber2Suffix": "string",
  "flatUnitType": "string",
  "flatUnitNumber": "string",
  "floorLevelType": "string",
  "floorLevelNumber": "string",
  "lotNumber": "string",
  "buildingName1": "string",
  "buildingName2": "string",
  "streetName": "string",
  "streetType": "string",
  "streetSuffix": "string",
  "postalDeliveryType": "string",
  "postalDeliveryNumber": 0,
  "postalDeliveryNumberPrefix": "string",
  "postalDeliveryNumberSuffix": "string",
  "localityName": "string",
  "postcode": "string",
  "state": "string"
}

Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf.

Properties

Name	Type	Required	Description
dpid	string	optional	Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier.
thoroughfareNumber1	PositiveInteger	optional	Thoroughfare number for a property (first number in a property ranged address).
thoroughfareNumber1Suffix	string	optional	Suffix for the thoroughfare number. Only relevant if thoroughfareNumber1 is populated.
thoroughfareNumber2	PositiveInteger	optional	Second thoroughfare number (only used if the property has a ranged address e.g., 23-25).
thoroughfareNumber2Suffix	string	optional	Suffix for the second thoroughfare number. Only relevant if thoroughfareNumber2 is populated.
flatUnitType	string	optional	Type of flat or unit for the address.
flatUnitNumber	string	optional	Unit number (including suffix, if applicable).
floorLevelType	string	optional	Type of floor or level for the address.
floorLevelNumber	string	optional	Floor or level number (including alpha characters).
lotNumber	string	optional	Allotment number for the address.
buildingName1	string	optional	Building/Property name 1.
buildingName2	string	optional	Building/Property name 2.
streetName	string	optional	The name of the street.
streetType	string	optional	The street type. Valid enumeration defined by Australia Post PAF code file.
streetSuffix	string	optional	The street type suffix. Valid enumeration defined by Australia Post PAF code file.
postalDeliveryType	string	optional	Postal delivery type. (e.g., PO BOX). Valid enumeration defined by Australia Post PAF code file.
postalDeliveryNumber	PositiveInteger	optional	Postal delivery number if the address is a postal delivery type.
postalDeliveryNumberPrefix	string	optional	Postal delivery number prefix related to the postal delivery number.
postalDeliveryNumberSuffix	string	optional	Postal delivery number suffix related to the postal delivery number.
localityName	string	mandatory	Full name of locality.
postcode	string	mandatory	Postcode for the locality.
state	string	mandatory	State in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation. `NSW`, `QLD`, `VIC`, `NT`, `WA`, `SA`, `TAS`, `ACT`, `AAT`.

ResponseErrorListV2

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": {
        "urn": "string"
      }
    }
  ]
}

Properties

Name	Type	Required	Default	Description
errors	[ErrorV2]	mandatory		List of errors.

ErrorV2

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "meta": {
    "urn": "string"
  }
}

Properties

Name	Type	Required	Description
code	string	mandatory	The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
title	string	mandatory	A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
detail	string	mandatory	A human-readable explanation specific to this occurrence of the problem.
meta	object	conditional	Additional data for customised error codes.
» urn	string	conditional	The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.

LinksPaginated

{
  "self": "string",
  "first": "string",
  "prev": "string",
  "next": "string",
  "last": "string"
}

Properties

Name	Type	Required	Description
self	URIString	mandatory	Fully qualified link that generated the current response document.
first	URIString	conditional	URI to the first page of this set. Mandatory if this response is not the first page.
prev	URIString	conditional	URI to the previous page of this set. Mandatory if this response is not the first page.
next	URIString	conditional	URI to the next page of this set. Mandatory if this response is not the last page.
last	URIString	conditional	URI to the last page of this set. Mandatory if this response is not the last page.

MetaPaginated

{
  "totalRecords": 0,
  "totalPages": 0
}

Properties

Name	Type	Required	Default	Description
totalRecords	NaturalNumber	mandatory		The total number of records in the full set. See pagination.
totalPages	NaturalNumber	mandatory		The total number of pages in the full set. See pagination.