Name	Type	Description
`sourceList`	`SourceListV5`	This member contains a list of `SourceV3` SourceV5 objects, each of which corresponds to a data source that is available to the person for the purpose of becoming fully verified. The The `setFields` web method expects one of these names as the `sourceId` input parameter.
`verificationResult`	`2310111377`	This member contains all of the verification information currently available for a person. It is a complete record of all checks that have been performed, their results, and an indicator of the person’s overall verification status.
`sourceFields`	`SourceFields`	This member contains a list of fields that are required for a particular data source. This includes the field’s name, type and other pertinent information for displaying and collecting a value for the field.
`checkResult`	`LastCheckResultV5`	This member indicates the outcome of a check against a data source that was performed during a call to the `setFields` web method. This member also indicates whether the check is still in progress.
`verificationToken`	`String`	This field is for future features in the API, and can be ignored for now.

LastCheckResultV5

...

Name	Type	Description
`overallVerificationStatus`	`String`	This member indicates the outcome of the entire verification process. Refer to the Reference Table for Overall Outcome States for values.
`ruleId`	`String`	The identifier for the rule that was used to determine the verification outcome.
`mode`	`String`	This member indicates the verification mode that was used. The mode is `null`, except in the following cases: “POSTOFFICE” – the person was verified by completing a Post Office form and visiting a branch of Australia Post, where their identity documents were manually inspected. “ASSISTED” – the person was verified by an administrative user. “EXTERNAL” – the person was verified outside of greenID, and the results have been loaded in to greenID.
`dateVerified`	`String`	The date this person became verified (null if they have not yet been verified).
`individualResults`	`List<2310111377>`	This member holds a list of results for the individual checks that have been performed to date.
`verificationID`	`String`	The unique identifier for this verification attempt.
`overallVerificationStatusReason`	String	Reason for overall status such as lockout due to GBG Alerts raised. This would specifically be: GBG_ALERT_RAISED

CheckResultV5

The CheckResultV5 type contains all the details of a check against a particular data source.

...

Name	Type	Description
`addressType`	`String`	Either `currentAddress` or `previousAddress`, depending on whether the address was nominated as their current or previous residential address at registration time. This field will only be present for fields that are address related fields.
`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.
`value`	`String`	This 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.
`extraData`	`List<2310111377>`	Any extra data associated with this check.
`format`	`String`	This member indicates the format of the data in this field. This field will only be present for fields that are encrypted, in which case it will have the value `PGPEncrypted`.
`masterRecordValue`	`String`	This member is reserved for use with combination sources. It's use is discussed below.
`changedValue`	`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 the data was changed to, and subsequently verified.
`extractedValue`	`String`	This member is reserved for use with combination sources. It's use is discussed below.

Regular data sources will have a list of FieldResultV3 elements that have the following elements populated:

name
status
value - if the value of the field was not changed for use with this data source.
changedValue - if the value of the field was changed for use with this data source, then the value field will not be present. Instead, the changedValue field will be present, and will contain the value that was used with this data source.
masterRecordValue - if the value of the field was changed for use with this data source, then the masterRecordValue is included to explicitly show the change that was made. The masterRecordValue field shows the value of the field from the master record, i.e. the value that was used when registering this verification attempt with greenID.

To illustrate the use of the value, changedValue and masterRecordValue elements, consider an example where the DoB field was not changed with respect to the master record. The DoB field would be represented by the XML snippet below:

Code Block
<fieldResult> <name>dob</name> <status>CONFIRMED</status> <value>1976-04-26</value> </fieldResult>

Now consider that the DoB was changed from 1/1/1980 on the master record to 1/4/1976 when using the data source, then the following XML snippet would be present:

Code Block
<fieldResult> <changedValue>1976-04-01</changedValue> <masterRecordValue>1980-01-01</masterRecordValue> <name>dob</name> <status>CHANGED</status> </fieldResult>

This scheme makes explicit every change that was made between the data used for the data source, and the master record.

The scheme becomes a little more complicated when combination sources are used. For a discussion of when the various elements of a combination source, please refer to the previous section about the 2310111377 type. The main thing to note in this section is which elements of the FieldResultV3 type are present in the different components comprising a combination source.

In the data extraction component of a combination source, the value field will be present if the status field has the value CONFIRMED, as in the example below.

Code Block
<fieldResult> <name>surname</name> <status>CONFIRMED</status> <value>Smith</value> </fieldResult>

If the value has been changed, and the status field has the value CHANGED, then the changedValue element will hold the value that the person altered, and the extractedValue element will contain the value that was automatically read from the ID document. For example, the XML below shows the FieldResultV5 element when a person has changed the value that was read from the card from "Smith" to the value "Jones":

Code Block
<fieldResult> <changedValue>Jones</changedValue> <extractedValue>Smith</extractedValue> <name>surname</name> <status>CHANGED</status> </fieldResult>

In the document registration match component of a combination source, the value field will be present if the status field has the value CONFIRMED, as in the example below:

Code Block
<fieldResult> <name>surname</name> <status>CONFIRMED</status> <value>Smith</value> </fieldResult>

If the value has been changed, and the status field has the value CHANGED, then the changedValue element will hold the value value that the person altered, and the masterRecordValue element will contain the value that is associated with the master record. For example, the XML below shows the FieldResultV5 element when a person has a master record where their surname is recorded as "Smith", and the combination source has the surname "Jones" (the value could be different because the person used an identity document with the surname "Jones" on it, or changed the value to "Jones" when asked to confirm the data automatically read from the card):

Code Block
<fieldResult> <changedValue>Jones</changedValue> <masterRecordValue>Smith</masterRecordValue> <name>surname</name> <status>CHANGED</status> </fieldResult>

PostOfficeDataV5

The PostOfficeDataV5 complex 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`	This parameter is GreenID's identifier for the client application. The value is supplied by GreenID.	Not null. Max 255 chars.
`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`	`2310111377`	Representation of the header of the flat file received from Australia Post.	Not null.
`poFileName`	`String`	The name of the actual file read from Australia Post.	Not null. Max 255 chars.
`records`	`2310111377[]`	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`	Unsigned amount in cents.	Max 255 chars.
`channelId`	`String`	0 = default	Max 255 chars.
`date`	`String`	ddmmyy (NOTE: system generated date with no slashes)	Max 255 chars.
`dateOfBirth`	`String`	ddmmyyyy represents the date of birth on the form that was checked.	Max 255 chars.
`filler`	`String`	Often there will be filler, it serves no purpose and should be ignored.	Max 255 chars.
`formVersion`	`String`	A-Z	Max 255 chars.
`givenName`	`String`	16 characters of the given name that was on the form that was checked.	Max 255 chars.
`id`	`Long`	Extra identifier that identifies this record. Not set by Australia Post.
`idWizardRefNo`	`String`		Max 255 chars.
`paymentMethod`	`String`	'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.	Max 255 chars.
`phoneNo`	`String`	Phone number as entered on the form that was checked.	Max 255 chars.
`postOfficeName`	`String`	Presumably the name of the Post Office the form was checked at.	Max 255 chars.
`recordNo`	`String`	Seems to be fixed as ‘1’.	Max 255 chars.
`recordType`	`String`	Seems to be fixed as ‘5’.	Max 255 chars.
`referenceNo`	`String`	The reference number used to identify this user. Most often this will be the userId. It must be 16 characters or less.	Max 255 chars.
`surname`	`String`	20 characters of the surname that was on the form that was checked.	Max 255 chars.
`totalNumberOfIdDocument`	`String`	Number of documents used to verify this user.	Max 255 chars.
`typeCode`	`String`		Max 255 chars.
`uniqueReferenceNumber`	`String`	wwwwwwttnnnnn, first 6 digits are AP Work Centre Code.	Max 255 chars.

DocumentRecord

The DocumentRecord complex type has the structure described below:

Member	Type	Description	Contract
`amount`	`String`	Always zero.	Max 255 chars.
`comments`	`String`		Max 255 chars.
`countryOfIssue`	`String`	Name of country from the document if applicable.	Max 255 chars.
`dateOfBirthMatchesaForm`	`String`	Y = Yes, X = not applicable	Max 255 chars.
`documentExpiryDate`	`String`	dd/mm/yyyy; spaces if not applicable NOTE: (manually entered date with slashes)	Max 255 chars.
`documentName`	`String`	This is an automatic lookup to convert the idDocumentType member into a human readable document name.	Max 255 chars.
`documentNumber`	`String`	Alphanumeric, e.g., passport number.	Max 255 chars.
`filler`	`String`	Often there will be filler, it serves no purpose and should be ignored.	Max 255 chars.
`id`	`Long`	Extra identifier that identifies this record. Not set by Australia Post.
`idDocumentType`	`String`	Code number representing the document type. The lookup for the name is done automatically and stored in the documentName member.	Max 255 chars.
`idWizardRefNo`	`String`		Max 255 chars.
`issuedBy`	`String`	This may be present instead of country of Issue, stateOrTerritoryOfIssue, utilityAccountIssuer and utilityAccountType. It may selectively hold this information in a less rigid format.	Max 255 chars.
`issueDate`	`String`	dd/mm/yyyy; spaces if not applicable NOTE: (manually entered date with slashes) May not be present.	Max 255 chars.
`nameMatchesForm`	`String`	Y = Yes, X = not applicable	Max 255 chars.
`photoMatch`	`String`	Y = Yes, X = not applicable	Max 255 chars.
`recordNo`	`String`		Max 255 chars.
`recordType`	`String`		Max 255 chars.
`referenceNo`	`String`		Max 255 chars.
`residentialAddressMatchesForm`	`String`	Y = Yes, X = not applicable	Max 255 chars.
`stateOrTerritoryOfIssue`	`String`	ACT, QLD, NSW, NT, SA, TAS, VIC or WA.	Max 255 chars.
`utilityAccountIssuer`	`String`	If specifically a utility, then the name.	Max 255 chars.
`utilityAccountType`	`String`	01 = electricity, 02 = gas, 03 = water, 04 = telephone	Max 255 chars.

NameValuePair

The NameValuePair complex type has the following structure:

Member

Type

Required?

Description

Contract

name

String

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.

Max 255 chars.

value

String

No

The actual data being passed in this pair.

Max 255 chars.

gbgAlertV5

The gbgAlertV5 type contains the result of the GBG Alert evaluations.

Reason for overall status such as lockout

Name	Type	Description
`overallAlertStatus`	`String`	The overall Alert Status for the registration. This is one of: NO_ALERT_RAISED - no configured Alert rules have been raised or there were alerts raised and locked, but an administrator has 'unlocked' them all ALERT_RAISED - one or more configured Alert rules have been raised NOT_ATTEMPTED - Alert rules have not been checked. ERROR
`score`	`Decimal`	The score is currently a placeholder. The score will be populated as GBG Alert is enhanced.
`raisedAlerts`	`raisedAlertListV5 i.e. a` `List<raisedAlert>`	a list of '`raisedAlert'` elements, each of which describe an individual Alert rule that has been 'raised'
`extraData`	`List<NameValuePair>`	Allows for extra information about the overall alert results to be returned if required in future.	`overallVerificationStatusReason`	String

Note: The VerificationResult contains the overallVerificationStatusReason which can also indicate if the verification has been locked out due to GBG

Alerts raised. This would specifically be: GBG_ALERT_RAISED

Alert. See: 2310111377

raisedAlertV5

Name	Type
`alertRule`	`String`	The name/code of the Alert rule that was raised/triggered, for example "Rule A2".
`description`	`String`	A text description of the Alert rule. This will be the same description as shown on the admin panel for the rule.
`firstRaised`	`String`	The timestamp of when this Alert rule was first raised. date:ISO8601_DATETIME_FORMAT e.g. 2023-08-16T23:11:51.544+1000
`multipleInstances`	`Boolean`	Indicates whether this rule has been raised more than once for this verification (true/false)
`alertRuleStatus`	`String`	Indicates the status of the Alert rule. Possible values: UNLOCKED - rule was previously raised but has been unlocked by an admin. LOCKED - rule has been raised and currently the verification is in a locked out state. RAISED (this will be used when there is no lock out status since customer not using locking for Alerts)
`extraData`	`List<NameValuePair>`	Allows for extra information about the raised alert (alert rule) to be returned if required in future

NameValuePair (i.e. used in extraData)

Name	Type	Description
`name`	String	The name of the additional information item we want to provide
`value`	String	The content/value of the additional information item

Version	Old Version 26	New Version Current
Changes made by	Sharmeen Hussain	Adrian Loo
Saved on	Oct 20, 2024	Mar 03, 2025

Versions Compared

Key

LastCheckResultV5

CheckResultV5

PostOfficeDataV5

DetailRecordHeader

DocumentRecord

NameValuePair

gbgAlertV5

raisedAlertV5

NameValuePair (i.e. used in extraData)

Content Comparison

Versions Compared

Key

LastCheckResultV5

CheckResultV5

PostOfficeDataV5

DetailRecordHeader

DocumentRecord

NameValuePair

gbgAlertV5

raisedAlertV5

NameValuePair (i.e. used in extraData)