Package com.onfido

Class DocumentManager

java.lang.Object

com.onfido.api.ResourceManager

com.onfido.DocumentManager

public class DocumentManager
extends ResourceManager

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FileDownload	download(String documentId)	Downloads specific documents belonging to an applicant.
Document	find(String documentId)	Retrieves a single document.
List<Document>	list(String applicantId)	Lists all documents belonging to an applicant.
Document	upload(InputStream inputStream, String fileName, Document.Request request)	Uploads a document as part of a multipart request.

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

DocumentManager

protected DocumentManager(Config config,
                          okhttp3.OkHttpClient client)

Method Detail

upload

public Document upload(InputStream inputStream,
                       String fileName,
                       Document.Request request)
                throws IOException,
                       OnfidoException

Uploads a document as part of a multipart request.

Parameters:

inputStream - the content from the desired file as an InputStream

fileName - the file name, including the file extension

request - the request body

Returns:

the Document

Throws:

IOException - the io exception

OnfidoException - the onfido exception

download

public FileDownload download(String documentId)
                      throws OnfidoException

Downloads specific documents belonging to an applicant.

Parameters:

documentId - the document id

Returns:

the downloaded file as a FileDownload

Throws:

OnfidoException - the onfido exception

find

public Document find(String documentId)
              throws OnfidoException

Retrieves a single document.

Parameters:

documentId - the document id

Returns:

the Document

Throws:

OnfidoException - the onfido exception

list

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

Lists all documents belonging to an applicant.

Parameters:

applicantId - the applicant id

Returns:

the list of Documents

Throws:

OnfidoException - the onfido exception