Detailed Watch List Result - getWatchlistResult

This method allows customers to retrieve a detailed watchlist result when they’re configured with Comprehensive Watchlist screening.

Web Service Endpoints

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 a positive integer. Max page size is 100.
pageNumber	String	No	Must be a positive integer.

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 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 a positive integer or does not exist.
InvalidPageSize - the value is not a positive integer or greater than 100.

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

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

Name	Type	Description
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 MATCH_CONFIRMED
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.

Name	Type	Description
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	The person's name.
dob	Data Structures V5	The person's date of birth.
currentResidentialAddress	Data Structures V5	The person's current residential address.
previousResidentialAddress	Data Structures V5	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.

Name	Type	Description
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.

Name	Type	Description
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	Type	Description
name	List<String>	Also Known As (an alias the person is known by).

Name	Type	Description
dob	List<String>	List of known dates of birth.

Name	Type	Description
dateOfDeath	List<String>	List of known dates of death.

Name	Type	Description
placeOfBirth	List<String>	List of known places of birth.

Name	Type	Description
Associate	List<Associate>	List of known Associates.

Name	Type	Description
name	String	Associate name.
type	String	Associate type.

Name	Type	Description
detailedCheckResult	List<DetailedCheckResult>	List of Detailed watchlist results.

Name	Type	Description
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.

Name	Type	Description
matchDataItems	List<MatchDataItem>	A list of name-value pairs, each of which contains a specific detail related to this match.

Name	Type	Description
name	String	The name of the field.
value	String	The name of the field.