Get Customer V1

This page documents the obsolete version 1 of the Get Customer endpoint.

Data Holders can retire this version after June 14th 2027. Data Recipients must update to newer versions prior to this date.

Get Customer

Code samples

GET https://mtls.dh.example.com/cds-au/v1/common/customer 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/common/customer', {
  method: 'GET',
  headers: headers
}).then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /common/customer

Obtain basic information on the customer that has authorised the current session.

Conventions

In the customer payloads there are conventions that are explained below.

Given Names

firstName represents the first of a person's given names.

middleNames represents a collection of given names if the person has more than one given name.

Where a data holder holds a person's given names as a single string in source systems, it may not possible in some situations to reliably split these given names into their component first and middle names. In these situations, data holders MAY use the firstName field to return the single string of given names and an empty middleNames array.

For example, if a person's given names are "John Paul Winston" and the Data Holder is unable to determine which is the first name, they can return "firstName": "John Paul Winston".

Endpoint Version


Version	1

Parameters

Name	In	Type	Required	Description
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 Software Product. 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 Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

200 Response

{
  "data": {
    "customerUType": "organisation",
    "person": {
      "lastUpdateTime": "string",
      "firstName": "string",
      "lastName": "string",
      "middleNames": [
        "string"
      ],
      "prefix": "string",
      "suffix": "string",
      "occupationCode": "string",
      "occupationCodeVersion": "ANZSCO_1220.0_2006_V1.0"
    },
    "organisation": {
      "lastUpdateTime": "string",
      "agentFirstName": "string",
      "agentLastName": "string",
      "agentRole": "string",
      "businessName": "string",
      "legalName": "string",
      "shortName": "string",
      "abn": "string",
      "acn": "string",
      "isACNCRegistered": null,
      "industryCode": "string",
      "industryCodeVersion": "ANZSIC_1292.0_2006_V1.0",
      "organisationType": "COMPANY",
      "registeredCountry": "AUS",
      "establishmentDate": "string"
    }
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	ResponseCommonCustomer
400	Bad Request	The following error codes MUST be supported: 400 - Invalid Field 400 - Missing Required Field 400 - Invalid Version	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.
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

ResponseCommonDiscoveryStatus

{
  "data": {
    "status": "OK",
    "explanation": "string",
    "detectionTime": "string",
    "expectedResolutionTime": "string",
    "updateTime": "string"
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name	Type	Required	Description
data	object	mandatory	none
» status	Enum	mandatory	Enumeration with values: `OK`: (implementation is fully functional). `PARTIAL_FAILURE`: (one or more endpoints are unexpectedly unavailable). `UNAVAILABLE`: (the full implementation is unexpectedly unavailable). `SCHEDULED_OUTAGE`: (an advertised outage is in effect).
» explanation	string	conditional	Provides an explanation of the current outage that can be displayed to an end customer. Mandatory if the status property is any value other than `OK`.
» detectionTime	DateTimeString	optional	The date and time that the current outage was detected. Should only be present if the status property is `PARTIAL_FAILURE` or `UNAVAILABLE`.
» expectedResolutionTime	DateTimeString	optional	The date and time that full service is expected to resume (if known). Should not be present if the status property has a value of `OK`.
» updateTime	DateTimeString	mandatory	The date and time that this status was last updated by the Data Holder.
links	Links	mandatory	none
meta	Meta	optional	none

Enumerated Values

Property	Value
status	OK
status	PARTIAL_FAILURE
status	SCHEDULED_OUTAGE
status	UNAVAILABLE

ResponseDiscoveryOutagesList

{
  "data": {
    "outages": [
      {
        "outageTime": "string",
        "duration": "string",
        "isPartial": true,
        "explanation": "string"
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name	Type	Required	Description
data	object	mandatory	none
» outages	[DiscoveryOutage]	mandatory	List of scheduled outages. Property is mandatory but may contain an empty list if no outages are scheduled.
links	Links	mandatory	none
meta	Meta	optional	none

DiscoveryOutage

{
  "outageTime": "string",
  "duration": "string",
  "isPartial": true,
  "explanation": "string"
}

Properties

Name	Type	Required	Description
outageTime	DateTimeString	mandatory	Date and time that the outage is scheduled to begin.
duration	ExternalRef	mandatory	Planned duration of the outage. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
isPartial	Boolean	optional	Flag that indicates, if present and set to `true`, that the outage is only partial meaning that only a subset of normally available endpoints will be affected by the outage.
explanation	string	mandatory	Provides an explanation of the current outage that can be displayed to an end customer.

ResponseCommonCustomer

{
  "data": {
    "customerUType": "organisation",
    "person": {
      "lastUpdateTime": "string",
      "firstName": "string",
      "lastName": "string",
      "middleNames": [
        "string"
      ],
      "prefix": "string",
      "suffix": "string",
      "occupationCode": "string",
      "occupationCodeVersion": "ANZSCO_1220.0_2006_V1.0"
    },
    "organisation": {
      "lastUpdateTime": "string",
      "agentFirstName": "string",
      "agentLastName": "string",
      "agentRole": "string",
      "businessName": "string",
      "legalName": "string",
      "shortName": "string",
      "abn": "string",
      "acn": "string",
      "isACNCRegistered": null,
      "industryCode": "string",
      "industryCodeVersion": "ANZSIC_1292.0_2006_V1.0",
      "organisationType": "COMPANY",
      "registeredCountry": "AUS",
      "establishmentDate": "string"
    }
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name	Type	Required	Description
data	object	mandatory	none
» customerUType	Enum	mandatory	The type of customer object that is present.
» person	CommonPerson	conditional	none
» organisation	CommonOrganisation	conditional	none
links	Links	mandatory	none
meta	Meta	optional	none

Enumerated Values

Property	Value
customerUType	organisation
customerUType	person

ResponseCommonCustomerDetailV2

{
  "data": {
    "customerUType": "organisation",
    "person": {
      "lastUpdateTime": "string",
      "firstName": "string",
      "lastName": "string",
      "middleNames": [
        "string"
      ],
      "prefix": "string",
      "suffix": "string",
      "occupationCode": "string",
      "occupationCodeVersion": "ANZSCO_1220.0_2006_V1.0",
      "phoneNumbers": [
        {
          "isPreferred": false,
          "purpose": "HOME",
          "countryCode": "+61",
          "areaCode": "string",
          "number": "string",
          "extension": "string",
          "fullNumber": "string"
        }
      ],
      "emailAddresses": [
        {
          "isPreferred": true,
          "purpose": "HOME",
          "address": "string"
        }
      ],
      "physicalAddresses": [
        {
          "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"
          },
          "purpose": "MAIL"
        }
      ]
    },
    "organisation": {
      "lastUpdateTime": "string",
      "agentFirstName": "string",
      "agentLastName": "string",
      "agentRole": "string",
      "businessName": "string",
      "legalName": "string",
      "shortName": "string",
      "abn": "string",
      "acn": "string",
      "isACNCRegistered": null,
      "industryCode": "string",
      "industryCodeVersion": "ANZSIC_1292.0_2006_V1.0",
      "organisationType": "COMPANY",
      "registeredCountry": "AUS",
      "establishmentDate": "string",
      "physicalAddresses": [
        {
          "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"
          },
          "purpose": "MAIL"
        }
      ]
    }
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name	Type	Required	Description
data	object	mandatory	none
» customerUType	Enum	mandatory	The type of customer object that is present.
» person	CommonPersonDetailV2	conditional	none
» organisation	CommonOrganisationDetailV2	conditional	none
links	Links	mandatory	none
meta	Meta	optional	none

Enumerated Values

Property	Value
customerUType	organisation
customerUType	person

CommonPerson

{
  "lastUpdateTime": "string",
  "firstName": "string",
  "lastName": "string",
  "middleNames": [
    "string"
  ],
  "prefix": "string",
  "suffix": "string",
  "occupationCode": "string",
  "occupationCodeVersion": "ANZSCO_1220.0_2006_V1.0"
}

Properties

Name	Type	Required	Default	Description
lastUpdateTime	DateTimeString	optional		The date and time that this record was last updated by the customer. If no update has occurred then this date should reflect the initial creation date for the data.
firstName	string	optional		For people with single names this field need not be present. The single name should be in the lastName field. Where a data holder cannot determine first and middle names from a collection of given names, a single string representing all given names MAY be provided.
lastName	string	mandatory		For people with single names, the single name should be in this field.
middleNames	[string]	mandatory		Field is mandatory but array may be empty.
prefix	string	optional		Also known as title or salutation. The prefix to the name (e.g., Mr, Mrs, Ms, Miss, Sir, etc.)
suffix	string	optional		Used for a trailing suffix to the name (e.g., Jr.)
occupationCode	ExternalRef	optional		Value is a valid [ANZSCO] Standard Occupation classification code. If the occupation code held by the data holder is not one of the supported [ANZSCO] versions, then it must not be supplied.
occupationCodeVersion	Enum	conditional	`ANZSCO_1220.0_2013_V1.2`	The applicable [ANZSCO] release version of the occupation code provided. Mandatory if an occupationCode is supplied. If occupationCode is supplied but occupationCodeVersion is absent, default is `ANZSCO_1220.0_2013_V1.2`.

Enumerated Values

Property	Value
occupationCodeVersion	ANZSCO_1220.0_2006_V1.0
occupationCodeVersion	ANZSCO_1220.0_2006_V1.1
occupationCodeVersion	ANZSCO_1220.0_2013_V1.2
occupationCodeVersion	ANZSCO_1220.0_2013_V1.3

CommonPersonDetailV2

{
  "lastUpdateTime": "string",
  "firstName": "string",
  "lastName": "string",
  "middleNames": [
    "string"
  ],
  "prefix": "string",
  "suffix": "string",
  "occupationCode": "string",
  "occupationCodeVersion": "ANZSCO_1220.0_2006_V1.0",
  "phoneNumbers": [
    {
      "isPreferred": false,
      "purpose": "HOME",
      "countryCode": "+61",
      "areaCode": "string",
      "number": "string",
      "extension": "string",
      "fullNumber": "string"
    }
  ],
  "emailAddresses": [
    {
      "isPreferred": true,
      "purpose": "HOME",
      "address": "string"
    }
  ],
  "physicalAddresses": [
    {
      "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"
      },
      "purpose": "MAIL"
    }
  ]
}

Properties

allOf

Name	Type	Required	Default	Description
anonymous	CommonPerson	mandatory		none

and

Name	Type	Required	Description
anonymous	object	mandatory	none
» phoneNumbers	[CommonPhoneNumber]	mandatory	Array is mandatory but may be empty if no phone numbers are held.
» emailAddresses	[CommonEmailAddress]	mandatory	May be empty.
» physicalAddresses	[CommonPhysicalAddressWithPurpose]	mandatory	Array is mandatory but may be empty if no valid addresses are held. One and only one address may have the purpose of `REGISTERED`. Zero or one, and no more than one, record may have the purpose of `MAIL`. If zero then the `REGISTERED` address is to be used for mail.

CommonOrganisation

{
  "lastUpdateTime": "string",
  "agentFirstName": "string",
  "agentLastName": "string",
  "agentRole": "string",
  "businessName": "string",
  "legalName": "string",
  "shortName": "string",
  "abn": "string",
  "acn": "string",
  "isACNCRegistered": null,
  "industryCode": "string",
  "industryCodeVersion": "ANZSIC_1292.0_2006_V1.0",
  "organisationType": "COMPANY",
  "registeredCountry": "AUS",
  "establishmentDate": "string"
}

Properties

Name	Type	Required	Default	Description
lastUpdateTime	DateTimeString	optional		The date and time that this record was last updated by the customer. If no update has occurred then this date should reflect the initial creation date for the data.
agentFirstName	string	optional		The first name of the individual providing access on behalf of the organisation. For people with single names this field need not be present. The single name should be in the lastName field.
agentLastName	string	mandatory		The last name of the individual providing access on behalf of the organisation. For people with single names, the single name should be in this field.
agentRole	string	mandatory		The role of the individual identified as the agent who is providing authorisation. Expected to be used for display. Default to "Unspecified" if the role is not known.
businessName	string	mandatory		Name of the organisation.
legalName	string	optional		Legal name, if different to the business name.
shortName	string	optional		Short name used for communication, if different to the business name.
abn	string	optional		Australian Business Number for the organisation.
acn	string	optional		Australian Company Number for the organisation. Required only if an ACN is applicable for the organisation type.
isACNCRegistered	Boolean	optional	`null`	`true` if registered with the ACNC. `false` if not. Absent or `null` if not confirmed.
industryCode	ExternalRef	optional		A valid ANZSIC code for the organisation. If the industry code held by the data holder is not one of the supported ANZSIC versions, then it must not be supplied.
industryCodeVersion	Enum	conditional	`ANZSIC_1292.0_2006_V2.0`	The applicable ANZSIC release version of the industry code provided. Should only be supplied if industryCode is also supplied. If industryCode is supplied but industryCodeVersion is absent, default is `ANZSIC_1292.0_2006_V2.0`.
organisationType	Enum	mandatory		Legal organisation type.
registeredCountry	ExternalRef	optional	`AUS`	Enumeration with values from ISO 3166 Alpha-3 country codes. Assumed to be `AUS` if absent.
establishmentDate	DateString	optional		The date the organisation described was established.

Enumerated Values

Property	Value
industryCodeVersion	ANZSIC_1292.0_2006_V1.0
industryCodeVersion	ANZSIC_1292.0_2006_V2.0
organisationType	COMPANY
organisationType	GOVERNMENT_ENTITY
organisationType	OTHER
organisationType	PARTNERSHIP
organisationType	SOLE_TRADER
organisationType	TRUST

CommonOrganisationDetailV2

{
  "lastUpdateTime": "string",
  "agentFirstName": "string",
  "agentLastName": "string",
  "agentRole": "string",
  "businessName": "string",
  "legalName": "string",
  "shortName": "string",
  "abn": "string",
  "acn": "string",
  "isACNCRegistered": null,
  "industryCode": "string",
  "industryCodeVersion": "ANZSIC_1292.0_2006_V1.0",
  "organisationType": "COMPANY",
  "registeredCountry": "AUS",
  "establishmentDate": "string",
  "physicalAddresses": [
    {
      "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"
      },
      "purpose": "MAIL"
    }
  ]
}

Properties

allOf

Name	Type	Required	Default	Description
anonymous	CommonOrganisation	mandatory		none

and

Name	Type	Required	Default	Description
anonymous	object	mandatory		none
» physicalAddresses	[CommonPhysicalAddressWithPurpose]	mandatory		Array is mandatory but may be empty if no valid addresses are held. One and only one address may have the purpose of `REGISTERED`. Zero or one, and no more than one, record may have the purpose of `MAIL`. If zero then the `REGISTERED` address is to be used for mail.

CommonPhoneNumber

{
  "isPreferred": false,
  "purpose": "HOME",
  "countryCode": "+61",
  "areaCode": "string",
  "number": "string",
  "extension": "string",
  "fullNumber": "string"
}

Properties

Name	Type	Required	Default	Description
isPreferred	Boolean	optional	`false`	May be `true` for one and only one entry to indicate the preferred phone number. Assumed to be `false` if not present.
purpose	Enum	mandatory		The purpose of the number as specified by the customer.
countryCode	string	optional	`+61`	If absent, assumed to be Australia (`+61`). The `+` should be included.
areaCode	string	conditional		Required for non Mobile Phones, if field is present and refers to Australian code - the leading `0` should be omitted.
number	string	mandatory		The actual phone number, with leading zeros as appropriate.
extension	string	optional		An extension number (if applicable).
fullNumber	ExternalRef	mandatory		Fully formatted phone number with country code, area code, number and extension incorporated. Formatted according to section 5.1.4. of [RFC3966].

Enumerated Values

Property	Value
purpose	HOME
purpose	INTERNATIONAL
purpose	MOBILE
purpose	OTHER
purpose	UNSPECIFIED
purpose	WORK

CommonEmailAddress

{
  "isPreferred": true,
  "purpose": "HOME",
  "address": "string"
}

Properties

Name	Type	Required	Description
isPreferred	Boolean	optional	May be `true` for one and only one email record in the collection. Denotes the default email address.
purpose	Enum	mandatory	The purpose for the email, as specified by the customer.
address	ExternalRef	mandatory	A correctly formatted email address, as defined by the addr-spec format in [RFC5322].

Enumerated Values

Property	Value
purpose	HOME
purpose	OTHER
purpose	UNSPECIFIED
purpose	WORK

CommonPhysicalAddressWithPurpose

{
  "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"
  },
  "purpose": "MAIL"
}

Properties

allOf

Name	Type	Required	Default	Description
anonymous	CommonPhysicalAddress	mandatory		none

and

Name	Type	Required	Default	Description
anonymous	object	mandatory		none
» purpose	Enum	mandatory		Enumeration of values indicating the purpose of the physical address.

Enumerated Values

Property	Value
purpose	MAIL
purpose	OTHER
purpose	PHYSICAL
purpose	REGISTERED
purpose	WORK

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`.

Links

{
  "self": "string"
}

Properties

Name	Type	Required	Default	Description
self	URIString	mandatory		Fully qualified link that generated the current response document.

Properties

None

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.

Get Customer V1

Get Customer

Conventions

Given Names

Endpoint Version

Parameters

Responses

Response Headers

Schemas

ResponseCommonDiscoveryStatus

Properties

Enumerated Values

ResponseDiscoveryOutagesList

Properties

DiscoveryOutage

Properties

ResponseCommonCustomer

Properties

Enumerated Values

ResponseCommonCustomerDetailV2

Properties

Enumerated Values

CommonPerson

Properties

Enumerated Values

CommonPersonDetailV2

Properties

CommonOrganisation

Properties

Enumerated Values

CommonOrganisationDetailV2

Properties

CommonPhoneNumber

Properties

Enumerated Values

CommonEmailAddress

Properties

Enumerated Values

CommonPhysicalAddressWithPurpose

Properties

Enumerated Values

CommonPhysicalAddress

Properties

Enumerated Values

CommonSimpleAddress

Properties

CommonPAFAddress

Properties

Links

Properties

Meta

Properties

ResponseErrorListV2

Properties

ErrorV2

Properties