com.blockscore.models

Class Person

java.lang.Object

com.blockscore.models.base.BasicResponse

com.blockscore.models.Person

public class Person
extends BasicResponse

The person model.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
QuestionSet	createQuestionSet() Creates a question set with no time limit.
QuestionSet	createQuestionSet(long timeLimit) Creates a question set with a set time limit in seconds.
Address	getAddress() Gets the address for this individual.
Date	getDateOfBirth() Gets the date of birth for this individual.
PersonDetails	getDetails() Contains a breakdown of how the status (validity) was determined.
String	getDocumentType() Gets the identifying document type.
String	getDocumentValue() Gets the identifying document value.
String	getFirstName() Gets the first name.
String	getIpAddress() Gets the IP address for this person.
String	getLastName() Gets the last name.
String	getMiddleName() Gets the middle name.
String	getNote() Gets any note data you have associated with the Person.
String	getPhoneNumber() Gets phone number of the individual (if available).
List<String>	getQuestionSetIds() Gets the question set ids associated with this Person record.
boolean	isValid() Returns either valid or invalid and is the culmination of whether or not the passed in information is valid against various databases and signals.
QuestionSet	retrieveQuestionSet(String questionSetId) Retrieve a question set you have created.
void	setAdapter(BlockscoreRestAdapter restAdapter) Sets the internal REST api adapter needed to complete Blockscore API requests.

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

Method Detail

setAdapter

public void setAdapter(BlockscoreRestAdapter restAdapter)

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

createQuestionSet

@NotNull
public QuestionSet createQuestionSet()

Creates a question set with no time limit.

Returns:

the new question set

createQuestionSet

public QuestionSet createQuestionSet(long timeLimit)

Creates a question set with a set time limit in seconds.

Parameters:

timeLimit - the time limit

Returns:

the new question set

retrieveQuestionSet

public QuestionSet retrieveQuestionSet(@NotNull
                                       String questionSetId)

Retrieve a question set you have created.

Parameters:

questionSetId - Question set ID

Returns:

the retrieved question set

getFirstName

@NotNull
public String getFirstName()

Gets the first name.

Returns:

the first name

getMiddleName

@Nullable
public String getMiddleName()

Gets the middle name. (Optional)

Returns:

the middle name

getLastName

@NotNull
public String getLastName()

Gets the last name.

Returns:

the last name

getDocumentType

@NotNull
public String getDocumentType()

Gets the identifying document type.

Returns:

the document type

getDocumentValue

@NotNull
public String getDocumentValue()

Gets the identifying document value.

Returns:

the document value

getDateOfBirth

@NotNull
public Date getDateOfBirth()

Gets the date of birth for this individual.

Returns:

the date of birth

getAddress

@NotNull
public Address getAddress()

Gets the address for this individual.

Returns:

the address

getPhoneNumber

@Nullable
public String getPhoneNumber()

Gets phone number of the individual (if available).

Returns:

the phone number

getIpAddress

@Nullable
public String getIpAddress()

Gets the IP address for this person. (if available)

Returns:

the IP address

getNote

@Nullable
public String getNote()

Gets any note data you have associated with the Person.

Returns:

the stored note data

isValid

public boolean isValid()

Returns either valid or invalid and is the culmination of whether or not the passed in information is valid against various databases and signals.

Returns:

true if valid

getDetails

@NotNull
public PersonDetails getDetails()

Contains a breakdown of how the status (validity) was determined. It will let you diagnose problems like address inconsistencies.

Returns:

the details breakdown

getQuestionSetIds

@NotNull
public List<String> getQuestionSetIds()

Gets the question set ids associated with this Person record.

Returns:

the question sets