Versions Compared

Version Old Version 1 New Version 2
Changes made by

Sharmeen Hussain

Sharmeen Hussain

Saved on

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 

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.

pageSize

String

No

Must be numeric

Max page size is 100

pageNumber

String

No

Must be a numeric value.

Exceptions

  • InvalidCustomerIdException – InvalidCustomerIdException– the accountId input parameter was missing or not recognised.

  • InvalidCertificateException  – – if certificates are used to connect, then this exception may be thrown if an invalid certificate is used.

  • InvalidPasswordException – the password input InvalidPasswordException – the password input parameter was missing or incorrect.

  • InvalidFieldException  – – one of the required fields was missing, or the format of a field was not valid.  For example, this may be thrown if an email address is not valid.

  • InvalidSourceIPAddressException - if web service IP restriction is enabled, then this exception will be thrown if the caller's IP address is not white-listed.

  • SystemException   - an unexpected error occurred.

  • InvalidPageNumber - the value is not numeric or does not exist.

  • InvalidPageSize - the value is not numeric or greater than 100.

...

This method returns WatchlistCheckDetails object. The following members will be populated:

  • Verification – Verification – this  field contains the results of checks that have been performed to date, and the person’s current verification status.

  • ProfileMatch – this field will contain a list of individual person profile matches returned from a watchlist provider

...