com.blockscore.models

Class Candidate.Builder

java.lang.Object

com.blockscore.models.Candidate.Builder

Enclosing class:

Candidate

public static class Candidate.Builder
extends java.lang.Object

The builder used for constructing a Candidate.

Constructor Summary

Constructors

Constructor and Description
Builder(BlockscoreApiClient client)

Method Summary

Modifier and Type	Method and Description
Candidate	create() Creates a new Candidate.
Candidate.Builder	setAddress(Address address) Sets the primary street address for this person.
Candidate.Builder	setDateOfBirth(java.util.Date dateOfBirth) Set the date of birth of your candidate.
Candidate.Builder	setFirstName(java.lang.String firstName) Sets the legal first name of the customer.
Candidate.Builder	setLastName(java.lang.String lastName) Sets the legal last name of the candidate.
Candidate.Builder	setMiddleName(java.lang.String middleName) Sets the legal middle name of the candidate.
Candidate.Builder	setNote(java.lang.String note) You can store additional information about the candidate here such as your internal system's identifier for this individual.
Candidate.Builder	setPassport(java.lang.String passport) Sets the passport number of the individual being verified.
Candidate.Builder	setSsn(java.lang.String ssn) Can be either the last 4 digits of the US Social Security Number or the whole SSN.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(BlockscoreApiClient client)

Method Detail

setFirstName

@NotNull
public Candidate.Builder setFirstName(@NotNull
                                               java.lang.String firstName)

Sets the legal first name of the customer.

Parameters:

firstName - the first name

Returns:

this

setMiddleName

@NotNull
public Candidate.Builder setMiddleName(@NotNull
                                                java.lang.String middleName)

Sets the legal middle name of the candidate.

Parameters:

middleName - the middle name

Returns:

this

setLastName

@NotNull
public Candidate.Builder setLastName(@NotNull
                                              java.lang.String lastName)

Sets the legal last name of the candidate.

Parameters:

lastName - the last name

Returns:

this

setNote

@NotNull
public Candidate.Builder setNote(@Nullable
                                          java.lang.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.Builder setSsn(@Nullable
                                         java.lang.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.Builder setPassport(@Nullable
                                              java.lang.String passport)

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

Parameters:

passport - the passport data

Returns:

this

setDateOfBirth

@NotNull
public Candidate.Builder setDateOfBirth(@Nullable
                                                 java.util.Date dateOfBirth)

Set the date of birth of your candidate.

Parameters:

dateOfBirth - the date of birth

Returns:

this

setAddress

public Candidate.Builder setAddress(@NotNull
                                    Address address)

Sets the primary street address for this person.

Parameters:

address - the address

Returns:

this

create

public Candidate create()

Creates a new Candidate.

Returns:

this