Versions Compared

Key

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

...


Name

Type

Required

Restrictions

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 this API.

verificationId

String

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 theverificationId, then greenID stores and uses that identifier; otherwise, greenID will generate a unique verificationId. The verificationId is returned to the caller.

ruleId

String

Yes

Callers have one or more rules configured for their greenID account. This string must identify one of those rules. Contact greenID for the names of the rules configured for your account. If only one rule is configured, then the string “default” will automatically select that rule.

name

Name

Yes


email

String

Yes

Must be a valid email address following the Standard Hibernate validation and checking Top Level Domain (TLD) is valid. See https://data.iana.org/TLD/tlds-alpha-by-domain.txt

currentResidentialAddress

AusAddress

Yes


previousResidentialAddress

AusAddress

May be null


dob

DateOfBirth

Yes

Must be a valid date in the past

homePhone

String

May be null

If present, must be 10 digits only.

workPhone

String

May be null

If present, must be 10 digits only.

mobilePhone

String

May be null

If present, must be 10 digits only, starting with “04”.

deviceIDData

String

May be null

This field is only needed for customers using the ReD Shield device verification service. Customers not using this service can leave this field blank. If you are using the ReD Shield device verification service, then please contact us for technical details regarding this field.

generateVerificationToken

boolean

No

This parameter indicates whether a verification token is required. If "true", the registerVerification method will produce a verification token, referred to as a userToken or verificationToken, just as the getUserToken method would. For information about verification tokens, please refer to the getUserToken method. If a verification token is not required, this parameter should be set to “false”.

extraData

nameValuePair[]

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

Return Value

...