...
Name | Type | Required? | Description |
|---|---|---|---|
customerId
| String 255 Chars | Yes
| This parameter is GreenID's identifier for the client application. The value is supplied by GreenID, and must be included with each registration request.
|
userId
| String 255 Chars | Yes
| This parameter is an identifier that the client uses for the individual being verified. GreenID does not use it as an identifier, but in order to easily locate individual's for a particular client application, the userIdis used. This must match a registered userId
|
Return Value
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
...
...
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
...
This method may raise a FaultDetails, inside which can be the following codes:
...