accountId

String

Yes

GreenID issues each customer with an accountId, which is a unique identifier by which greenID knows the caller. This accountId must be supplied with every call to any method in this API.

password

String

Yes

Each customer is issued a password that must be supplied with every call to any web method in the API.

verificationId

String

No (may be null)

Each verification attempt for a person must have a verificationId, which is a unique identifier that greenID and the caller use to refer to a verification attempt for an individual person.  If the caller supplies the verificationId then greenID stores and uses that identifier; otherwise, greenID will generate a unique verificationId.  The verificationId is returned to the caller.

ruleId

String

No (may be null)

Callers have a specific rule configured for their greenID Hosted account.  This string must identify a rule. Contact greenID for the name of the rule configured for your Hosted account.  If only one rule is configured, then the string “default” will automatically select that rule.

name

Name

Yes

currentResidentialAddress

Address

No (may be null)

 dob

DateOfBirth

Yes

Must be a valid date in the past.

mobilePhone

String

No (may be null)

email

String

No (may be null)

extraData

List <NameValuePair>

No

This parameter allows the customer to send extra data that will need to be agreed upon before implementation. It will be a simple key /value format. If there is no previous agreement for certain keys to be sent in this field then it will be ignored.

verificationId

String

overallVerificationStatus

String

The overall status of the verification.

hostedInviteUrl

String

ShortUrl generated for this registration for this call.

responseErrorFlag

Boolean

True = an error occurred
False = no error occurred

responseErrorMessage

String

A message providing information regarding the error that occurred.

errorReasonCode

String

Indicates the type of error that occurred.

accountId

String

Yes

GreenID issues each customer with an accountId, which is a unique identifier by which greenID knows the caller. This accountId must be supplied with every call to any method in this API.

password

String

Yes

Each customer is issued a password that must be supplied with every call to any web method in the API.

verificationId

String

No (may be null)

Each verification attempt for a person must have a verificationId, which is a unique identifier that greenID and the caller use to refer to a verification attempt for an individual person.  If the caller supplies the verificationId then greenID stores and uses that identifier; otherwise, greenID will generate a unique verificationId.  The verificationId is returned to the caller.

ruleId

String

No (may be null)

Callers have a specific rule configured for their greenID Hosted account.  This string must identify a rule. Contact greenID for the name of the rule configured for your Hosted account.  If only one rule is configured, then the string “default” will automatically select that rule.

givenNames

String

Yes

Cannot be null. Cannot be the empty string.

Max 255 characters.

middleNames

String

No (may be null)

Max 255 characters.

surname

Stromg

Yes

Cannot be null. Cannot be the empty string.

Max 255 characters.

country

String

No (may be null)

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.

postcode

String

No (may be null)

A 4 digit Australian postcode.

state

String

No (may be null)

A valid abbreviation of an Australian state or territory, i.e. ACT, QLD, NSW, NT, SA, TAS, VIC or WA.

streetName

String

No (may be null)

Max 255 characters.

streetNumber

String

No (may be null)

Max 255 characters.

streetType

String

No (may be null)

A valid street type abbreviation, e.g. “ST”, “RD” etc.

suburb

String

No (may be null)

Max 255 characters.

 dob

DateOfBirth

Yes

Must be a valid date in the past.

mobilePhone

String

No (may be null)

email

String

No (may be null)

verificationId

String

overallVerificationStatus

String

The overall status of the verification.

hostedInviteUrl

String

ShortUrl generated for this registration for this call.

responseErrorFlag

Boolean

True = an error occurred
False = no error occurred

responseErrorMessage

String

A message providing information regarding the error that occurred.

errorReasonCode

String

Indicates the type of error that occurred.

smsID

This field should not be used in your implementation, it will be removed from the response soon.

smsStatus

This field should not be used in your implementation, it will be removed from the response soon.