Detailed Watch List Result - getWatchlistResult

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

Default is 25.

Must be a positive integer.

Max page size is 100.

pageNumber

String

No

Must be a positive integer.

accountId is missing

FieldValidationFault

accountID is missing

verificationId is missing

FieldValidationFault

verificationid is missing

verificationId is not found

VerificationIdNotFoundFault

<verificationId supplied in the request>

Invalid password or invalid accountId

InvalidPasswordFault

<password or accountId supplied in the request>

Invalid page size

FieldValidationFault

Invalid page size

Invalid page number

FieldValidationFault

Invalid page number

Page number does not exist

FieldValidationFault

An unexpected problem occurred. Invalid page number.

Invalid certificates (when certificates are used)

InvalidCertificateFault

<accountId supplied in the request>

Invalid Source IP Address

InvalidIPAddressFault

IP address

System exception

SytemFault

Details will vary based on exception type.

verification

Verification

Details of the verification these watchlist results relate to.

dateChecked

String

Date timestamp the watchlist check performed.

lastActionDate

String

Date time stamp the watchlist check was last actioned.

watchlistProduct

String

Name of the watchlist product

overallWatchlistStatus

String

Overall watchlist status.  Will be one of:

• ERROR

• FOUND_ON_LIST

• NOT_FOUND_ON_LIST

• MATCH_REVIEW_REQURIED

customerIdentifier

String 

The ‘case’ identifier from the watchlist provider.

numberOfProfileMatches

int

Total number of person profiles matched.

watchlistCheckDetailsCurrentPage

int

Current page number - Use default if no value provided in the input.

watchlistCheckDetailsPageTotal

int

Total number of pages.

watchlistCheckDetailsPageSize

int

Current page size - use default if no value provided in the input.

profileMatch

List<ProfileMatch >

Details of individual person profile(s) matched.

verificationId

String

The unique identifier for this verification attempt.

dateCreated

String

The timestamp of when this verification attempt was created. The string will be formatted in the ISO 8601 format. The pattern used to generate this string in Java is yyyy-MM-dd'T'HH:mm:ss.SSSZ.

registrationDetails

RegistrationDetails

Details that were supplied for registration.

name

Data Structures V5 | DataStructuresV5 Name

The person's name.

dob

Data Structures V5 | DataStructuresV5 DateOfBirth

The person's date of birth.

currentResidentialAddress

Data Structures V5 | DataStructuresV5 Address

The person's current residential address.

previousResidentialAddress

Data Structures V5 | DataStructuresV5 Address

The person's previous residential address.

email

String

The person’s email address, if provided.

homePhone

String

The person’s home phone number, if provided.

mobilePhone

String

The person’s mobile phone number, if provided,

workPhone

String

The person’s work phone number, if provided.

personName

String

Name of the person matched.

personMatchType

String

Person matched type.

personWatchlistsStatus

String

Watchlist status of the profile.

personMatchSummary

PersonMatchSummary

Match summary of the profile.

listofAlternativeNames

ListofAlternativeNames

Lists of Also Known As.

listOfDateOfBirth

ListOfDateOfBirth

List of known DOBs.

listOfDateOfDeath

ListOfDateOfDeath

List of known Date of Death.

listOfPlaceOfBirth

ListOfPlaceOfBirth

List of known Place of Birth.

listOfAssociates

ListOfAssociates

List of known associate details. 

listOfDetailedCheckedResults

ListOfDetailedCheckedResults

List of detailed check results.

associatesCount

int

Count of associates matched. Zero (0) if no match.

sanctionsCount

int

Count of sanctions matched. Zero (0) if no match.

warningsAndOtherListsCounts

int

Count of warnings and lists matched. Zero (0) if no match.

PEPCount

int

Count of pep matched. Zero (0) if no match.

adverseMediaCount

int

Count of media matched. Zero (0) if no match.

name

List<String>

Also Known As (an alias the person is known by).

dob

List<String>

List of known dates of birth.

dateOfDeath

List<String>

List of known dates of death.

placeOfBirth

List<String>

List of known places of birth.

Associate

List<Associate>

List of known Associates.

name

String

Associate name.

type

String

Associate type.

detailedCheckResult

List<DetailedCheckResult>

List of Detailed watchlist results.

listingStartDate

String

Date the source was first published.

listingEndDate

String

Date the source was removed.

watchlistCategory

String

The type of watchlist match.  Will be one of:

• PEP

• Sanctions

• WarningsAndOtherLists

• AdverseMedia

watchlistUrl

String

URL of the source.

watchlistName

String

Name of the source.

watchlistDescription

String

A description of the source.

pepClass

String

The classification of the source, will be one of:

• pep-class-1

• pep-class-2

• pep-class-3

• pep-class-4

listOfMatchDataItems

ListOfMatchDataItems

A list of fields associated with the match.  This list contains the specific details of this match.

matchDataItems

List<MatchDataItem>

A list of name-value pairs, each of which contains a specific detail related to this match.

name

String

The name of the field.

value

String

The name of the field.