Package com.onfido

Class CheckManager

java.lang.Object

com.onfido.api.ResourceManager

com.onfido.CheckManager

public class CheckManager
extends ResourceManager

Manager class for the Check resource type. Contains resource-specific methods for interacting with the API.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CheckManager(Config config, okhttp3.OkHttpClient client)

Method Summary

Modifier and Type	Method	Description
Check	create(Check.Request request)	Initiates a check for an applicant, which can contain one or more reports.
FileDownload	download(String checkId)	Downloads a check.
Check	find(String checkId)	Retrieves a single check.
List<Check>	list(String applicantId)	Returns all checks for an applicant.
void	resume(String checkId)	Resumes a paused check.

Methods inherited from class com.onfido.api.ResourceManager

addFormDataParam, deleteRequest, downloadRequest, get, post, put, readInputStream, uploadRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckManager

protected CheckManager(Config config,
                       okhttp3.OkHttpClient client)

Method Detail

create

public Check create(Check.Request request)
             throws OnfidoException

Initiates a check for an applicant, which can contain one or more reports.

Parameters:

request - the request body

Returns:

the Check

Throws:

OnfidoException - the onfido exception

find

public Check find(String checkId)
           throws OnfidoException

Retrieves a single check.

Parameters:

checkId - the check id

Returns:

the Check

Throws:

OnfidoException - the onfido exception

list

public List<Check> list(String applicantId)
                 throws OnfidoException

Returns all checks for an applicant.

Parameters:

applicantId - the applicant id

Returns:

a list of Checks

Throws:

OnfidoException - the onfido exception

resume

public void resume(String checkId)
            throws OnfidoException

Resumes a paused check. If successful, returns a 204 No Content response.

Parameters:

checkId - the check id

Throws:

OnfidoException - the onfido exception

download

public FileDownload download(String checkId)
                      throws OnfidoException

Downloads a check.

Parameters:

checkId - the check id

Returns:

the downloaded file as a FileDownload

Throws:

OnfidoException - the onfido exception