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

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.

Customers who are checking watch lists only will have a specific ruleId that will need to be passed in this field. Please confirm this ruleId with your greenID representative.

name

Name

Yes

email

String

May be null

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

Address

Yes

previousResidentialAddress

Address

May be null

dob

DateOfBirth

Yes

Must be a valid date in the past.

homePhone

String

May be null

Must be provided in E164 international format (i.e. prefixed with +<country code>). 

workPhone

String

May be null

Must be provided in E164 international format (i.e. prefixed with +<country code>). 

mobilePhone

String

May be null

Must be provided in E164 international format (i.e. prefixed with +<country code>). 

deviceId

String

May be null

The unique deviceID of the customer's device which remains fixed over time. This is usually provided by businesses such as Threatmetrix or Iovation.

ipAddress

String

May be null

A valid IPv4 or IPv6 address.

deviceIDData

String

May be null

This parameter 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 Edentiti for technical details regarding this field.

generateGreenIdWebVerificationToken

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 getGreenIdWebVerificationToken  method would.  For information about verification tokens, please refer to the getGreenIdWebVerificationToken method.  If a verification token is not required, this parameter should be set to  “false”.

List<NameValuePair>

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

Yes

This parameter must be a valid verficationId that has been previously registered, via the registerVerification web method, with greenID.  If the verficationId cannot be found in the greenID database, then an InvalidTokenException will be thrown.

greenIdWebVerificationToken

String

No

This parameter is reserved for the SimpleUI.  All customers should ignore this parameter, and set it to null.

extraData

List<NameValuePair>

No

This parameter is used to send additional request information to greenID.  The various parameters are mentioned as required in this documentation.