com.blockscore.models

Class WatchlistHit

java.lang.Object

com.blockscore.models.WatchlistHit

public class WatchlistHit
extends Object

Model representing a watchlist hit.

Constructor Summary

Constructors

Constructor and Description
WatchlistHit()

Method Summary

Modifier and Type	Method and Description
Address	getAddress() Gets the address of the candidate.
List<Address>	getAddresses() Gets the addresses from the watchlist.
String	getAlternateNames() Returns the set of alternate names of a candidate.
List<BirthRange>	getBirths() Returns the list of date of birth ranges matched against this candidate.
double	getConfidence() Gets the confidence rating (between 0 and 1.0).
Date	getDateOfBirth() Returns the candidate's date of birth.
List<Document>	getDocuments() Returns the list of documents matched against this candidate.
EntityType	getEntryType() Returns the entry type of this watchlist hit.
String[]	getMatchingInfo() Gets a list of elements in your request that match this watchlist hit.
String	getName() Returns the full name for this candidate.
List<NameResult>	getNames() Returns the list of names matched against this candidate.
String	getNotes() Returns the notes for this candidate.
String	getPassports() Gets the list of passport numbers for a candidate.
String	getRawAddress() Returns the address of this candidate in raw form.
String	getSsn() Gets the ssn for this candidate.
String	getTitle() Returns the title for this candidate.
String	getUrl() Returns the url for this candidate.
String	getWatchlist() Gets the watchlist on which this match took place.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WatchlistHit

public WatchlistHit()

Method Detail

getWatchlist

@NotNull
public String getWatchlist()

Gets the watchlist on which this match took place.

Returns:

the watchlist

getEntryType

@NotNull
public EntityType getEntryType()

Returns the entry type of this watchlist hit.

Returns:

the entry type

getMatchingInfo

@NotNull
public String[] getMatchingInfo()

Gets a list of elements in your request that match this watchlist hit.

Returns:

an array of strings containing the matching info

getConfidence

public double getConfidence()

Gets the confidence rating (between 0 and 1.0).

Returns:

the confidence value

getUrl

@Nullable
public String getUrl()

Returns the url for this candidate.

Returns:

the url

getNotes

@Nullable
public String getNotes()

Returns the notes for this candidate.

Returns:

the notes data

getTitle

@Nullable
public String getTitle()

Returns the title for this candidate.

Returns:

the title

getName

@Nullable
public String getName()

Returns the full name for this candidate.

Returns:

the full name

getAlternateNames

@NotNull
public String getAlternateNames()

Returns the set of alternate names of a candidate.

Returns:

the array of alternate names, not null

getDateOfBirth

@Nullable
public Date getDateOfBirth()

Returns the candidate's date of birth.

Returns:

the date of birth

getSsn

@Nullable
public String getSsn()

Gets the ssn for this candidate.

Returns:

the ssn

getPassports

@Nullable
public String getPassports()

Gets the list of passport numbers for a candidate.

Returns:

the array of passport numbers

getAddress

@Nullable
public Address getAddress()

Gets the address of the candidate.

Returns:

the address

getRawAddress

@Nullable
public String getRawAddress()

Returns the address of this candidate in raw form.

Returns:

the address in raw form

getNames

@NotNull
public List<NameResult> getNames()

Returns the list of names matched against this candidate.

Returns:

the list of names

getBirths

@NotNull
public List<BirthRange> getBirths()

Returns the list of date of birth ranges matched against this candidate.

Returns:

the list of birth ranges

getDocuments

@NotNull
public List<Document> getDocuments()

Returns the list of documents matched against this candidate.

Returns:

the list of documents

getAddresses

@NotNull
public List<Address> getAddresses()

Gets the addresses from the watchlist.

Returns:

the list of addresses