Versions Compared

Key

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

Insert excerpt
Version 2 greenID API
Version 2 greenID API
nopaneltrue

Table of Contents

CurrentStatusV2

...

 

Name

Type

Description

sourceList

SourceListV2

This member contains a list of Source objects, each of which corresponds to a data source that is available to the person for the purpose of becoming fully verified.  The setFields web method expects one of these names as thesourceId input parameter.

verificationResultVerificationResultV2

Data Structures V2#Data Structures V2#VerificationResultV2

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

SourceFieldsV2

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.

checkResultLastCheckResultV2This 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.
userTokenStringThis field is for future features in the API, and can be ignored for now.

LastCheckResultV2

...

 

Name

Type

Description

state

String

This member reflects the current state of the source.  The valid values are the same as the state member of the CheckResult object.  If a source has not been used, then this member will be “EMPTY”.

passed

boolean

This member indicates whether this source has been passed, i.e. the check is in one of the verified states.

name

String

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 setFields web method.

availablebooleanThis member indicates whether this data source is currently available; sometimes a particular data source may not be available.
notRequiredbooleanThis 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.
oneSourceLeftbooleanThis 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.
orderintThe 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

List<NameValuePair>

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 withname=”class” and value=”required”.

SourceFieldsV2

...

 

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

labelStringThis member contains label.  Please refer to the section on Labels.
selectItemList<NameValuePair> This member contains a list of item names and values for a select item Field.
attributeList<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 NameValuePair with name=”class” and value=”required”.
orderIntegerThe 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 names are expected to be those that have previously been returned from the GetFields method for a particular data source.  For example, a Visa number will be represented by a NameValuePair with name=”visa_number” and value=”11111111”.

...

 

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

NameTypeDescriptionRestrictions
currentResidentialAddressAddressThe person's current residential address. 
dateCreatedDateTimeThe timestamp of when this verification attempt was created. 
dobstringThe person's date of birth. 
emailstringThe person's email address.May be null. Must be a valid email address.
extraDataList<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.
homePhonestring If present, must be 10 digits only.
mobilePhonestring If present, must be 10 digits only.
nameNameThe person's name. 
previousResidentialAddressAddressThe person's previous residential address. 
workPhonestring 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 fields that are present or required will depend on the country that is specified.  Similarly, 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 requirements for individual countries, please contact greenID.

NameTypeDescriptionContract
alleystring  
amalgamatedMunicipalitystring  
areaString  
avenueString  
blockString  
cantonString  
chomeString  
cityString  
countryStringThe 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.
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

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

...

 

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.

modeStringThe 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.
dateVerifiedDateThe 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.

postOfficeDataPostOfficeDataV2Data Structures V2#Data Structures V2#PostOfficeDataV2If 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.
extraDataList<NameValuePair>Any extra data associated with this check.

FieldResultV2

 

Name

Type

Description

addressTypeStringEither "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 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.

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

 

 

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.