com.blockscore.models

Class Person.Builder

java.lang.Object

com.blockscore.models.Person.Builder

Enclosing class:

Person

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

The builder used for constructing a Person.

Constructor Summary

Constructors

Constructor and Description
Builder(BlockscoreApiClient client)

Method Summary

Modifier and Type	Method and Description
Person	create() Creates a new Person.
Person.Builder	setAddress(Address address) Sets the person's address.
Person.Builder	setDateOfBirth(java.util.Date dateOfBirth) Sets the date of birth.
Person.Builder	setDocumentType(java.lang.String documentType) Sets the identifying document type.
Person.Builder	setDocumentValue(java.lang.String documentValue) Sets the identifying document value.
Person.Builder	setFirstName(java.lang.String firstName) Sets the legal first name of the customer.
Person.Builder	setIpAddress(java.lang.String ipAddress) Sets a person's IP address.
Person.Builder	setLastName(java.lang.String lastName) Sets the legal last name of the customer.
Person.Builder	setMiddleName(java.lang.String middleName) Sets the legal middle name of the customer (optional).
Person.Builder	setNote(java.lang.String note) You can store additional information about the person here such as your internal system's identifier for this individual.
Person.Builder	setPhoneNumber(java.lang.String phoneNumber) Sets a person's phone number.

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 Person.Builder setFirstName(@NotNull
                                            java.lang.String firstName)

Sets the legal first name of the customer.

Parameters:

firstName - the legal first name

Returns:

this

setMiddleName

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

Sets the legal middle name of the customer (optional).

Parameters:

middleName - the legal middle name

Returns:

this

setLastName

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

Sets the legal last name of the customer.

Parameters:

lastName - the legal last name

Returns:

this

setDocumentType

@NotNull
public Person.Builder setDocumentType(@NotNull
                                               java.lang.String documentType)

Sets the identifying document type.

Parameters:

documentType - the document type

Returns:

this

setDocumentValue

@NotNull
public Person.Builder setDocumentValue(@NotNull
                                                java.lang.String documentValue)

Sets the identifying document value.

Parameters:

documentValue - the document value

Returns:

this

setDateOfBirth

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

Sets the date of birth.

Parameters:

dateOfBirth - the date of birth

Returns:

this

setAddress

@NotNull
public Person.Builder setAddress(@NotNull
                                          Address address)

Sets the person's address.

Parameters:

address - the address

Returns:

this

setPhoneNumber

@NotNull
public Person.Builder setPhoneNumber(@Nullable
                                              java.lang.String phoneNumber)

Sets a person's phone number.

If you set the phone number, we will use it as an additional 'positive' data point for the consumer. That is, if it is provided, it will help us identify them, but if we cannot, they will not be penalized.

Parameters:

phoneNumber - the phone number for this individual.

Returns:

this

setIpAddress

@NotNull
public Person.Builder setIpAddress(@Nullable
                                            java.lang.String ipAddress)

Sets a person's IP address.

Your customers' IP address can be passed to us for storage purposes. Soon we will be using this information for anti-fraud and verification purposes. With this information we will be able to back-test your verifications when this feature is released.

Parameters:

ipAddress - the IP address

Returns:

this

setNote

@NotNull
public Person.Builder setNote(@Nullable
                                       java.lang.String note)

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

Parameters:

note - Note to store.

Returns:

this

create

public Person create()

Creates a new Person.

Returns:

the new person