...

The CurrentStatusV2 object is the sole return type of all the web methods in the API.  It It is intended to provide information about what has just happened, as well as giving an overview of the person’s current verification status, and the list of data sources that will help the person become fully verified.  Always Always presenting this information helps to reduce the chattiness between greenID and the customer application.

The LastCheckResultV2 object is intended to give a snapshot of the status of a check that has been performed during a call to the setFields web method.

...

FieldListV2

...

Name	Type	Description
sourceField	List<FieldV2>	This member simply contains a list of Field objects.

FieldV2

...

Name	Type	Description
type	String	The type of HTML input that is required (at least strongly suggested) for collecting the data for this field from the person.  For For example, a value of “text” would indicate a simple HTML text input is appropriate.
name	String	The name of the HTML input that would collect data for this field from the person.  The 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.
value	String	This member contains any pre-existing value for the HTML field.  For For example, the Field with the name “aec_givenname” will be pre-populated with the person’s given name (derived from the person’s master record established during the call to the RegisterUser web method) the first time the GetFields method is called with the sourceId “aec”.
label	String	This member contains label.  Please Please refer to the section on Labels.
selectItem	List<NameValuePair>	This member contains a list of item names and values for a select item Field.
attribute	List<NameValuePair>	This member contains a list of the names and values of any HTML attributes that this Field has.  For For example, the attribute class=”required” would be represented by a NameValuePair with name=”class” and value=”required”.
order	Integer	The order in which this field should be displayed. This feature is not yet implemented, and the value is always zero.

InputFields

 

Name	Type	Description
input	List<NameValuePair>	This member contains a list of names and values that correspond to input parameters to the setFields web method.  The The names are expected to be those that have previously been returned from the GetFields method for a particular data source.  For For example, a Visa number will be represented by a NameValuePair with name=”visa_number” and value=”11111111”.

...

This type is a convenience type for holding a partial date, especially useful for representing dates of birth.  This This type holds just the date part, and does not contain any reference to a time component or timezone; this avoids potential issues with date of birth timestamps arising from different timezones.

 

Name	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

Name	Type	Description	Restrictions
currentResidentialAddress	Address	The person's current residential address.
dateCreated	DateTime	The timestamp of when this verification attempt was created.
dob	string	The person's date of birth.
email	string	The person's email address.	May be null. Must be a valid email address.
extraData	List<NameValuePair>	Any extra data elements that were supplied with the original registration. Identifier such as document numbers will not be present in the list, even if they were supplied at registration time.	Zero or more elements.
homePhone	string			If present, must be 10 digits only.
mobilePhone	string		If present, must be 10 digits only.
name	Name	The person's name.
previousResidentialAddress	Address	The person's previous residential address.
workPhone	string			If present, must be 10 digits only.

Address

The Address object is intended to serve as a container for address information for countries with a variety of different address schemes and formats.  The The fields that are present or required will depend on the country that is specified.  SimilarlySimilarly, fields may have different validation rules depending on the country, for example, the field "postcode" must be a four digit string for an Australian address, but it must be a five digit string for a US address.  For For requirements for individual countries, please contact greenID.

 

Name	Type	Description	Contract
alley	string
amalgamatedMunicipality	string
area	String
avenue	String
block	String
canton	String
chome	String
city	String
country	String	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.
county	String
deliveryNumber	String
department	String
direction	String
dispatchingInformation	String
district	String
divisionFive	String
divisionFour	String
divisionOne	String
divisionThree	String
divisionTwo	String
flatNumber	String
level	String
locality	String
location	String
mailCentre	String
municipality	String
neighbourhood	String
organisation	String
parish	parish	String
	personName	String
poBox	String
postcode	String
prefecture	String
propertyName	String
province	String
quarter	String
region	String
ruralArea	String
ruralLocality	String
sector	String
sectorNumber	String
state	String
streetName	String
streetNumber	String
streetType	String
subdistrict	String
subregion	String
suburb	String
town	String			townCity	String
townshiptownCity	String
township	String
urbanLocality	String
village	String

Name

The Name complex type has the following structure: 

Member	Type	Required?	Description	Contract
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.

VerificationResultV2

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

...

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

CheckResultV2

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

...

Name	Type	Description
name	String	The name of the check. For example, if a check against the Electoral Roll was attempted, then the name would be “AEC”. As each customer will accept a different set of checks, customers should refer to their individual rules document for the list of names that they can expect. Refer to Data Source Reference for a list of data source names.
state	String	The state of the individual check. For a list of possible states, please see the Reference Table of individual source states.
method	String	The method via which the check was carried out. This is an enumerated type, for a list of possible values, please see the Reference Table of Method Names.
mode	String	The verification mode used for this specific check. This shows HOW the check was made. Please see the Reference Table of possible modes. This can be null which indicates that no mode was used.
dateVerified	Date	The date that this particular check became verified (or null if the check is not verified).
fieldResults	List<FieldResultV2>	Only the fields that were successfully checked, or were changed, are returned. Any field that was not checked is not returned. Note that this may mean the array is empty.
postOfficeData	PostOfficeData	If and only if the name of the CheckResult is “PostOffice” then this member will be present. Otherwise it will be null. This represents the raw data retrieved from Australia Post.
extraData	List<NameValuePair>	Any extra data associated with this check.

FieldResultV2

 

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.
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 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 the data was changed to, and subsequently verified.
data	String	This member contains the original data that was supplied the time of registration, or the “master record”.   In In the case of a status of ADDITION (see the Reference Table of Field Status) then this will hold the added data.
extraData	List<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.
format	String	This member indicates the format of the data in this field.  The The value of this field will vary according to individual customer configurations.  The 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’       ‘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     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

NameValuePair

The NameValuePair complex type has the following structure:

 

Member	Type	Required?	Description	Contract
name	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	String 255 Chars	No	The actual data being passed in this pair.