com.blockscore.models

Class Candidate

java.lang.Object

com.blockscore.models.base.BasicResponse

com.blockscore.models.Candidate

public class Candidate
extends BasicResponse

The candidate model.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Candidate.Builder The builder used for constructing a Candidate.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Candidate()

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes this candidate.
Address	getAddress() Gets the primary street address for this person.
Date	getDateOfBirth() The date of birth of your candidate.
String	getFirstName() The legal first name of the customer.
String	getLastName() Gets the legal last name of the customer.
String	getMiddleName() The legal middle name of the customer.
String	getNote() Gets any note data you have associated with the Candidate.
String	getPassport() The passport number of the individual being verified.
PaginatedResult<WatchlistHit>	getPastHits() Retrieve all historical watchlist hits for this candidate.
List<Candidate>	getRevisionHistory() Returns a complete revision history of a candidate's edits.
String	getSsn() Gets either the 4 digits of the US Social Security Number or the whole SSN.
Candidate	save() Updates this candidate.
PaginatedResult<WatchlistHit>	searchWatchlists() Performs a watchlist search for this candidate with default search options.
PaginatedResult<WatchlistHit>	searchWatchlists(Double similarityThreshold) Performs a watchlist search for this candidate with a specified similarity threshold.
PaginatedResult<WatchlistHit>	searchWatchlists(EntityType entityType) Performs a watchlist search for this candidate with a specified entity type.
PaginatedResult<WatchlistHit>	searchWatchlists(EntityType entityType, Double similarityThreshold) Performs a watchlist search for this candidate.
void	setAdapter(BlockscoreRestAdapter restAdapter) Sets the internal REST api adapter needed to complete Blockscore API requests.
Candidate	setAddress(Address address) Sets the primary street address for this person.
Candidate	setDateOfBirth(Date dateOfBirth) Set the date of birth of your candidate.
Candidate	setFirstName(String firstName) Sets the legal first name of the customer.
Candidate	setLastName(String lastName) Sets the legal last name.
Candidate	setMiddleName(String middleName) Sets the legal middle name of the customer.
Candidate	setNote(String note) You can store additional information about the candidate here such as your internal system's identifier for this individual.
Candidate	setPassport(String passport) Sets the passport number of the individual being verified.
Candidate	setSsn(String ssn) Can be either the last 4 digits of the US Social Security Number or the whole SSN.

Methods inherited from class com.blockscore.models.base.BasicResponse

getCreatedAtDate, getId, getUpdatedAtDate, isLiveMode

Methods inherited from class java.lang.Object

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

Constructor Detail

Candidate

protected Candidate()

Method Detail

save

public Candidate save()

Updates this candidate.

Returns:

this

delete

public void delete()

Deletes this candidate.

getRevisionHistory

public List<Candidate> getRevisionHistory()

Returns a complete revision history of a candidate's edits. This allows you to maintain a full audit trail of when and how you update a client's profile over time. The latest revision is presented at the top of the list, and the original is at the end of the list.

Returns:

the list of candidates

getPastHits

public PaginatedResult<WatchlistHit> getPastHits()

Retrieve all historical watchlist hits for this candidate.

Returns:

the paginated historical watchlist hits

searchWatchlists

public PaginatedResult<WatchlistHit> searchWatchlists()

Performs a watchlist search for this candidate with default search options. Results may be of entities or individuals.

Returns:

the paginated watchlist hit results

searchWatchlists

public PaginatedResult<WatchlistHit> searchWatchlists(Double similarityThreshold)

Performs a watchlist search for this candidate with a specified similarity threshold. Results may be of entities or individuals.

Parameters:

similarityThreshold - the tolerated similarity threshold

Returns:

the paginated watchlist hit resultss

searchWatchlists

public PaginatedResult<WatchlistHit> searchWatchlists(EntityType entityType)

Performs a watchlist search for this candidate with a specified entity type. The default similarity threshold is used.

Parameters:

entityType - the type of entity

Returns:

the paginated watchlist hit results

searchWatchlists

public PaginatedResult<WatchlistHit> searchWatchlists(EntityType entityType,
                                                      Double similarityThreshold)

Performs a watchlist search for this candidate.

Parameters:

entityType - the type of entity

similarityThreshold - the accepted threshold of similarity

Returns:

the paginated watchlist hit results

setFirstName

@NotNull
public Candidate setFirstName(@NotNull
                                       String firstName)

Sets the legal first name of the customer.

Parameters:

firstName - the first name

Returns:

this

setMiddleName

@NotNull
public Candidate setMiddleName(@NotNull
                                        String middleName)

Sets the legal middle name of the customer.

Parameters:

middleName - the middle name

Returns:

this

setLastName

@NotNull
public Candidate setLastName(@NotNull
                                      String lastName)

Sets the legal last name.

Parameters:

lastName - the last name

Returns:

this

setNote

@NotNull
public Candidate setNote(@Nullable
                                  String note)

You can store additional information about the candidate here such as your internal system's identifier for this individual. This will allow you to keep track of them.

Parameters:

note - the additional information to store.]

Returns:

this

setSsn

@NotNull
public Candidate setSsn(@Nullable
                                 String ssn)

Can be either the last 4 digits of the US Social Security Number or the whole SSN.

Parameters:

ssn - the SSN to use

Returns:

this

setPassport

@NotNull
public Candidate setPassport(@Nullable
                                      String passport)

Sets the passport number of the individual being verified. is only used for verifying non-US customers.

Parameters:

passport - the passport number

Returns:

this

setDateOfBirth

@NotNull
public Candidate setDateOfBirth(@Nullable
                                         Date dateOfBirth)

Set the date of birth of your candidate.

Parameters:

dateOfBirth - the date of birth

Returns:

this

setAddress

public Candidate setAddress(@NotNull
                            Address address)

Sets the primary street address for this person.

Parameters:

address - the primary street address

Returns:

this

getFirstName

@Nullable
public String getFirstName()

The legal first name of the customer.

Returns:

the first name

getMiddleName

@Nullable
public String getMiddleName()

The legal middle name of the customer.

Returns:

the middle name

getLastName

@Nullable
public String getLastName()

Gets the legal last name of the customer.

Returns:

the last name

getNote

@Nullable
public String getNote()

Gets any note data you have associated with the Candidate.

Returns:

the stored note

getSsn

@Nullable
public String getSsn()

Gets either the 4 digits of the US Social Security Number or the whole SSN.

Returns:

the SSN

getPassport

@Nullable
public String getPassport()

The passport number of the individual being verified. is only used for verifying non-US customers.

Returns:

the passport number

getDateOfBirth

@Nullable
public Date getDateOfBirth()

The date of birth of your candidate.

Returns:

the date of birth

getAddress

@Nullable
public Address getAddress()

Gets the primary street address for this person.

Returns:

the address

setAdapter

public void setAdapter(BlockscoreRestAdapter restAdapter)

Sets the internal REST api adapter needed to complete Blockscore API requests.