name

String

The name of the field. The possible name will depend on the source used. Again which sources used will depend on the individual customer setup, and new sources, with potentially new fields are constantly being added. For a list of possible field names for each source, please refer to the Data Source Reference tables.

status

String

This member indicates the status of the field.  Refer to the Reference Table for Field Status for possible values.

dataDifference

String

This member will contain changed values. That is, if a value was changed in order to become verified, then this member will contain the value that was the data was changed to, and subsequently verified.

flatNumber

String

255 Chars

No

The flat number component of an address. For example, in the address “1/5 Fake St”, “1” is the flat number.

streetNumber

String

255 Chars

No

The street number component of an address. In the example above, “5” is the street number.

streetName

String

255 Chars

Yes

The name of the street.

Cannot be null. Cannot be the empty string.

streetType

String

255 Chars

Yes

A valid Australian street type.

A valid Australian street type, or its recognised abbreviation. For a full list of acceptable values, please see Street Types

suburbis the street number.

streetName

String

255 Chars

Yes

The suburb or town component name of the individual's addressstreet.

Cannot be null. Cannot be the empty string.

For New Zealand addresses, this field should contain the suburb; the "city" address element is not required by any current greenID New Zealand data sources.

statethe empty string.

streetType

String

255 Chars

Yes

The state component of the individual's address. Must be a valid Australian state or territory.

One of:

• ACT
• NSW
• NT
• QLD
• SA
• TAS
• VIC
• WA

postcode

A valid Australian street type.

A valid Australian street type, or its recognised abbreviation. For a full list of acceptable values, please see Street Types

suburb

String

255 Chars

Yes

The postcode suburb or town component of the individual's address. Must be a valid Australian postcode.

Must be 4 numbers between 0 and 9 (i.e. as a regular expression: ^[\d]{4}$)

country

String

255 Chars

Yes

The country code. This must be the ISO 3166 country code. The country code can be given in either the alpha-2, alpha-3 or numeric format.

Please refer to https://www.iso.org/obp/ui/#search for a full (and up to date) list of ISO 3166 country codes.

.

Cannot be null. Cannot be the empty string.

For New Zealand addresses, this field should contain the suburb; the "city" address element is not required by any current greenID New Zealand data sources.

state

String

255 Chars

Yes

The state component of the individual's address. Must be a valid Australian state or territory.

One of:

• ACT
• NSW
• NT
• QLD
• SA
• TAS
• VIC
• WA

postcode

String

255 Chars

Yes

The postcode component of the individual's address. Must be a valid Australian postcode.

Must be 4 numbers between 0 and 9 (i.e. as a regular expression: ^[\d]{4}$)

country

String

255 Chars

Yes

The country code. This must be the ISO 3166 country code. The country code can be given in either the alpha-2, alpha-3 or numeric format.

Please refer to https://www.iso.org/

obp/

ui/#search for a full (and up to date) list of ISO 3166 country codes.

customerId

String

255 Chars

This parameter is GreenID's identifier for the client application. The value is supplied by GreenID.

Not null.

documents

String

Human readable string that is a comma separated list of all the names of the documents used to verify this user.

Not null.

header

detailRecordHeader

Representation of the header of the flat file received from Australia Post

Not null.

poFileName

String

255 Chars

The name of the actual file read from Australia Post

Not null.

records

documentRecord[]

List of individual representations of the documents used to verify this User

Not null.

amount

String

255 Chars

Unsigned amount in cents.

channelId

String

255 Chars

0 = default

date

String

255 Chars

ddmmyy (NOTE: system generated date with no slashes)

dateOfBirth

String

255 Chars

ddmmyyyy represents the date of birth on the form that was checked.

filler

String

255 Chars

Often there will be filler, it serves no purpose and should be ignored.

formVersion

String

255 Chars

A-Z

givenName

String

255 Chars

16 characters of the given name that was on the form that was checked.

id

Long

Extra identifier that identifies this record. Not set by Australia Post.

idWizardRefNo

String

255 Chars

paymentMethod

String

255 Chars

'00' = Cash/EFTPOS/Direct Debit, '01'-'09' = number of Cheques, '11' = VISA, '12 = MasterCard. Note: This may differ per contract, but in general the above applies.

phoneNo

String

255 Chars

Phone number as entered on the form that was checked.

postOfficeName

String

255 Chars

Presumably the name of the Post Office the form was checked at.

recordNo

String

255 Chars

Seems to be fixed as ‘1’

recordType

String

255 Chars

Seems to be fixed as ‘5’

referenceNo

String

255 Chars

The reference number used to identify this user. Most often this will be the userId. It must be 16 characters or less.

surname

String

255 Chars

20 characters of the surname that was on the form that was checked.

totalNumberOfIdDocument

String

255 Chars

Number of documents used to verify this user

typeCode

String

255 Chars

uniqueReferenceNumber

String

255 Chars

wwwwwwttnnnnn, first 6 digits are AP Work Centre Code.

amount

String

255 Chars

Always zero

comments

String

255 Chars

countryOfIssue

String

255 Chars

Name of country from the document if applicable

dateOfBirthMatchesaForm

String

255 Chars

Y = Yes, X = not applicable

documentExpiryDate

String

255 Chars

dd/mm/yyyy; spaces if not applicable NOTE: (manually entered date with slashes)

documentName

String

255 Chars

This is an automatic lookup to convert the idDocumentType member into a human readable document name.

documentNumber

String

255 Chars

Alphanumeric, eg passport number.

filler

String

255 Chars

Often there will be filler, it serves no purpose and should be ignored.

id

Long

Extra identifier that identifies this record. Not set by Australia Post.

idDocumentType

String

255 Chars

Code number representing the document type. The lookup for the name is done automatically and stored in the documentName member.

idWizardRefNo

String

255 Chars

issuedBy

String

255 Chars

This may be present instead of country of Issue, stateOrTerritoryOfIssue, utilityAccountIssuer and utilityAccountType. It may selectively hold this information in a less rigid format.

issueDate

String

255 Chars

dd/mm/yyyy; spaces if not applicable NOTE: (manually entered date with slashes)

May not be present.

nameMatchesForm

String

255 Chars

Y = Yes, X = not applicable

photoMatch

String

255 Chars

Y = Yes, X = not applicable

recordNo

Strin

255 Chars

recordType

String

255 Chars

referenceNo

String

255 Chars

residentialAddressMatchesForm

String

255 Chars

Y = Yes, X = not applicable

stateOrTerritoryOfIssue

String

255 Chars

ACT, QLD, NSW, NT, SA, TAS, VIC or WA;

utilityAccountIssuer

String

255 Chars

If specifically a utility, then the name.

utilityAccountType

String

255 Chars

01 = electricity, 02 = gas, 03 = water, 04 = telephone

honorific

String

255 Chars

No

The honorific component of a person’s name, eg. “Mr”, “Miss”, etc.

givenName

String

255 Chars

Yes

A person’s given name.

Cannot be null. Cannot be the empty string.

middleNames

String

255 Chars

No

A person’s middle names. Note that there can be multiple names.

surname

String

255 Chars

Yes

A person’s surname or last name.

Cannot be null. Cannot be the empty string.