...
Name | Type | Description |
---|---|---|
|
| This member reflects the current state of the source. The valid values are the same as the state member of the |
|
| This member indicates whether this source has been passed, i.e. the check is in one of the verified states. |
|
| This member is the name of the data source. This name is expected to be used to refer to this data source in calls to the |
available | boolean | This member indicates whether this data source is currently available; sometimes a particular data source may not be available. |
notRequired | boolean | This member indicates whether this data source can help a person become fully verified. If the value is true , then there is no point using this data source because it cannot help the person become fully verified. |
oneSourceLeft | boolean | This member indicates whether completing this data source will make a person fully verified. This member is very valuable because it indicates which sources should be attempted first, thereby shortening the verification process. |
order | int | The order in which the source would be displayed if it were being displayed by greenID. Sources that are more likely to result in the person becoming fully verified are at the top of the list, i.e. their “order” number is lower. |
attributes |
| This member contains a list of HTML attributes that should be applied to any HTML input collecting input from a person. For example, the HTML attribute “class=’required’” would be represented by a NameValuePair with name=”class” and value=”required” . |
SourceFieldsV3
...
Name | Type | Description |
---|---|---|
|
| The type of HTML input that is required (at least strongly suggested) for collecting the data for this field from the person. For example, a value of “text” would indicate a simple HTML text input is appropriate. |
|
| The name of the HTML input that would collect data for this field from the person. The name also indicates what the data field is, for example, the value “aec_givenname” indicates the field holds the given name for the AEC data source. |
|
| This member contains any pre-existing value for the HTML field. For example, the |
label | String | This member contains label. Please refer to the section on Labels. |
selectItem | List<NameValuePair> | This member contains a list of item names and values for a select item FieldV3 . |
attribute | List<60369636=NameValuePair> | This member contains a list of the names and values of any HTML attributes that this Field has. For example, the attribute class=”required” would be represented by a 60369636 NameValuePair with name=”class” and value=”required” . |
InputFields
...
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. |
|
| 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. |
|
| 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<60369636NameValuePair> | 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 thevalue
field will not be present. Instead, thechangedValue
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 themasterRecordValue
is included to explicitly show the change that was made. ThemasterRecordValue
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 60369636
CheckResultV3
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 FieldResultV3
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 FieldResultV3
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> |
PostOfficeDataV3
The PostOfficeDataV3
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 |
---|---|---|---|
|
| This parameter is GreenID's identifier for the client application. The value is supplied by GreenID. | Not null. Max 255 chars. |
|
| Human readable string that is a comma separated list of all the names of the documents used to verify this user. | Not null. |
| Representation of the header of the flat file received from Australia Post. | Not null. | |
|
| The name of the actual file read from Australia Post. | Not null. Max 255 chars. |
| 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 |
---|---|---|---|
|
| Unsigned amount in cents. | Max 255 chars. |
|
| 0 = default | Max 255 chars. |
|
| ddmmyy (NOTE: system generated date with no slashes) | Max 255 chars. |
|
| ddmmyyyy represents the date of birth on the form that was checked. | Max 255 chars. |
|
| Often there will be filler, it serves no purpose and should be ignored. | Max 255 chars. |
|
| A-Z | Max 255 chars. |
|
| 16 characters of the given name that was on the form that was checked. | Max 255 chars. |
|
| Extra identifier that identifies this record. Not set by Australia Post. | |
|
| Max 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. | Max 255 chars. |
|
| Phone number as entered on the form that was checked. | Max 255 chars. |
|
| Presumably the name of the Post Office the form was checked at. | Max 255 chars. |
|
| Seems to be fixed as ‘1’. | Max 255 chars. |
|
| Seems to be fixed as ‘5’. | Max 255 chars. |
|
| 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. |
|
| 20 characters of the surname that was on the form that was checked. | Max 255 chars. |
|
| Number of documents used to verify this user. | Max 255 chars. |
|
| 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 |
---|---|---|---|
|
| Always zero. | Max 255 chars. |
|
| Max 255 chars. | |
|
| Name of country from the document if applicable. | Max 255 chars. |
|
| Y = Yes, X = not applicable | Max 255 chars. |
|
| dd/mm/yyyy; spaces if not applicable NOTE: (manually entered date with slashes) | Max 255 chars. |
|
| This is an automatic lookup to convert the idDocumentType member into a human readable document name. | Max 255 chars. |
|
| Alphanumeric, e.g., passport number. | Max 255 chars. |
|
| Often there will be filler, it serves no purpose and should be ignored. | Max 255 chars. |
|
| Extra identifier that identifies this record. Not set by Australia Post. | |
| String | Code number representing the document type. The lookup for the name is done automatically and stored in the documentName member. | Max 255 chars. |
|
| Max 255 chars. | |
| 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. |
|
| dd/mm/yyyy; spaces if not applicable NOTE: (manually entered date with slashes) May not be present. | Max 255 chars. |
|
| Y = Yes, X = not applicable | Max 255 chars. |
|
| Y = Yes, X = not applicable | Max 255 chars. |
|
| Max 255 chars. | |
|
| Max 255 chars. | |
|
| Max 255 chars. | |
|
| Y = Yes, X = not applicable | Max 255 chars. |
|
| ACT, QLD, NSW, NT, SA, TAS, VIC or WA. | Max 255 chars. |
| String | If specifically a utility, then the name. | Max 255 chars. |
|
| 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 |
---|---|---|---|---|
|
| 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. |
|
| No | The actual data being passed in this pair. | Max 255 chars. |