com.blockscore.net

Class BlockscoreApiClient

java.lang.Object

com.blockscore.net.BlockscoreApiClient

public class BlockscoreApiClient
extends java.lang.Object

The Blockscore Java API client.

Constructor Summary

Constructors

Constructor and Description
BlockscoreApiClient(java.lang.String apiKey) Creates a BlockscoreApiClient.

Method Summary

Modifier and Type	Method and Description
BlockscoreRestAdapter	getAdapter() Gets the internal REST api adapter needed to complete Blockscore API requests.
PaginatedResult<Candidate>	listCandidates() Lists a historical record of all candidates you have created.
PaginatedResult<Company>	listCompanies() Lists verified companies a historical record of all company verifications that you have completed.
PaginatedResult<Person>	listPeople() Lists a historical record of all verifications that you have completed.
Candidate	retrieveCandidate(java.lang.String id) Retrieves a candidate.
Company	retrieveCompany(java.lang.String id) Gets a single company exactly as it was when you created it.
Person	retrievePerson(java.lang.String id) Gets a single person exactly as it was when you created it.
static void	useVerboseLogs(boolean useVerboseLogs) Turns on/off logging.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockscoreApiClient

public BlockscoreApiClient(@NotNull
                           java.lang.String apiKey)

Creates a BlockscoreApiClient. Requires a valid API key for construction to occur successfully.

Parameters:

apiKey - the valid Blockscore API key

Method Detail

useVerboseLogs

public static void useVerboseLogs(boolean useVerboseLogs)

Turns on/off logging. Must be set before creating API client to take effect.

Parameters:

useVerboseLogs - whether or not to use verbose network logs.

retrievePerson

@NotNull
public Person retrievePerson(@NotNull
                                      java.lang.String id)

Gets a single person exactly as it was when you created it. This route is useful for auditing purposes as you can provide proof that a verification took place along with all of its associated data.

Parameters:

id - ID of Person.

Returns:

the person, not null

listPeople

@NotNull
public PaginatedResult<Person> listPeople()

Lists a historical record of all verifications that you have completed. The list is displayed in reverse chronological order (newer people appear first).

Returns:

the historical listing of created people, not null

retrieveCompany

@NotNull
public Company retrieveCompany(@NotNull
                                        java.lang.String id)

Gets a single company exactly as it was when you created it. This route is useful for auditing purposes as you can provide proof that a company verification took place along with all of its associated data.

Parameters:

id - ID of the Company.

Returns:

the company, not null

listCompanies

@NotNull
public PaginatedResult<Company> listCompanies()

Lists verified companies a historical record of all company verifications that you have completed. The list is displayed in reverse chronological order (newer company verifications appear first).

Returns:

the historical listing of created companies, not null

retrieveCandidate

@NotNull
public Candidate retrieveCandidate(@NotNull
                                            java.lang.String id)

Retrieves a candidate.

Parameters:

id - ID of the candidate.

Returns:

the candidate, not null

listCandidates

@NotNull
public PaginatedResult<Candidate> listCandidates()

Lists a historical record of all candidates you have created. The list is displayed in reverse chronological order (newer candidates appear first).

Returns:

the historical listing of created candidates, not null

getAdapter

public BlockscoreRestAdapter getAdapter()

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

Returns:

the REST adapter