Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 

Name

Type

Description

day

int

The day component of a date of birth.

month

int

The month component of a date of birth.

year

int

The full year component of a date of birth, for example 1975, i.e. not 75.

RegistrationDetailsV2

Need a summary

NameTypeDescription
currentResidentialAddressAddress 
dateCreatedDateTime 
dobstring 
emailstring 
extraDataList<NameValuePair>  
homePhonestring 
mobilePhonestring 
nameName 
previousResidentialAddressAddress 
workPhonestring 

Address

NameTypeDescription
alleystring 
amalgamatedMunicipalitystring 
areaString 
avenueString 
blockString 
cantonString 
chomeString 
cityString 
countryString 
countyString 
deliveryNumberString 
departmentString 
directionString 
dispatchingInformationString 
districtString 
divisionFiveString 
divisionFourString 
divisionOneString 
divisionThreeString 
divisionTwoString 
flatNumberString 
levelString 
localityString 
locationString 
mailCentreString 
municipalityString 
neighbourhoodString 
organisationString 
parishString 
personNameString 
poBoxString 
postcodeString 
prefectureString 
propertyNameString 
provinceString 
quarterString 
regionString 
ruralAreaString 
ruralLocalityString 
sectorString 
sectorNumberString 
stateString 
streetNameString 
streetNumberString 
streetTypeString 
subdistrictString 
subregionString 
suburbString 
townString 
townCityString 
townshipString 
urbanLocalityString 
villageString 

Name

Name

The Name complex type has the following structure: 

Member

Type

Required?

Description

Contract

givenName

honorific

String

255 Chars

 

No

The honorific

String

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

 

 

middleNamesString

 

 

surname

givenName

String

 

255 Chars

VerificationResultV2

...

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.

VerificationResultV2

The VerificationResultV2 type describes the person’s verification results to date.  This is always returned so that the caller always has the latest results for that person.

...

 

Name

Type

Description

addressTypeString 

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.

dataStringThis member contains the original data that was supplied the time of registration, or the “master record”.   In the case of a status of ADDITION (see the Reference Table of Field Status) then this will hold the added data.
extraDataList<NameValuePair>This contains information about the data. At this time it contains either “previousAddress” or “currentAddress” to indicate which address this data was checked as.
formatStringThis member indicates the format of the data in this field.  The value of this field will vary according to individual customer configurations.  The most common value is “plain”, which indicates a plain text field.

 

PostOfficeDataV2 

The complex type PostOfficeDataV2 has the structure described below.  

This type and the following members are for the most part exact representations of the fields found in an Australia Post contract. The reader should be aware of the individual Australia Post contract they will be using to ensure that they can match up the fields. These fields are retrieved from a flat file and stored in Strings with no interpretation of the meanings of the fields. Not all implementations of an Australia Post contract will have all the fields detailed below.

Member

Type

Description

Contract

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.

 

DetailRecordHeader 

The complex type DetailRecordHeader has the structure described below:  

Member

Type

Description

Contract

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.

 

DocumentRecord 

The complex type DocumentRecord has the structure described below:  

Member

Type

Description

Contract

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

Always zero

 

 

 

documentExpiryDatecomments

 

String

255 Chars

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

 

 

documentNamecountryOfIssue

 

String

255 Chars

This is an automatic lookup to convert the idDocumentType member into a human readable document name.Name of country from the document if applicable

 

 

 

documentNumberdateOfBirthMatchesaForm

 

String

255 Chars

Alphanumeric, eg passport number.Y = Yes, X = not applicable

 

 

fillerdocumentExpiryDate

 

String

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

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

 

 

id

Long

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

 

idDocumentTypedocumentName

 

String

255 Chars

Code number representing the document type. The lookup for the name is done automatically and stored in the documentName memberThis is an automatic lookup to convert the idDocumentType member into a human readable document name.

 idWizardRefNo

 

documentNumber

 

String

255 Chars

 

Alphanumeric, eg passport number.

 

 

 

issuedByfiller

 

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.

 

 

issueDateOften 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

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

May not be presentCode number representing the document type. The lookup for the name is done automatically and stored in the documentName member.

 

 

nameMatchesFormidWizardRefNo

 

String

255 CharsY = Yes, X = not applicable

 

 

 

 

photoMatchissuedBy

 

String

255 Chars

Y = Yes, X = not applicable

 

 

recordNo

 

Strin

255 Chars

 

 

 

 

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

 

 

referenceNonameMatchesForm

 

String

255 Chars 

Y = Yes, X = not applicable

 

 

 

residentialAddressMatchesFormphotoMatch

 

String

255 Chars

Y = Yes, X = not applicable

 

 

stateOrTerritoryOfIssuerecordNo

 

StringStrin

255 CharsACT, QLD, NSW, NT, SA, TAS, VIC or WA;

 

 

 

 

utilityAccountIssuerrecordType

 

String

255 CharsIf specifically a utility, then the name.

 

 

 

 

utilityAccountTypereferenceNo

 

String

255 Chars

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

 

 

NameValuePair

The NameValuePair complex type has the following structure:

 

residentialAddressMatchesForm

 

Member

String

Type

Required?

Description

Contract

name

255 Chars

Y = Yes, X = not applicable

 

stateOrTerritoryOfIssue

 

String

255 Chars

No

This will identify the data that is stored in this pair.

Needs to match an agreed upon value and be unique in the list.

value

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

 

 

utilityAccountIssuer

 

String

255 Chars

No

The actual data being passed in this pair.

 

 

If specifically a utility, then the name.

 

 

utilityAccountType

 

String

255 Chars

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

 

 

Name

The Name complex type has

NameValuePair

The NameValuePair complex type has the following structure:

 

Member

Type

Required?

Description

Contract

honorific

name

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

This will identify the data that is stored in this pair.

Needs to match an agreed upon value and be unique in the list.

value

String

255 Chars

No

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

The actual data being passed in this pair.

 

surname
 

String

 

255 Chars

 

Yes

A person’s surname or last name.

Cannot be null. Cannot be the empty string.