Index (Onfido API Java Client 2.6.0 API)

A B C D E F G H I L M N O P R S T U V W
All Classes All Packages

A

addFormDataParam(MultipartBody.Builder, String, Object) - Method in class com.onfido.api.ResourceManager
address - Variable in class com.onfido.Onfido: The manager class for the Address resource
address(Address.Request) - Method in class com.onfido.models.Applicant.Request: The applicants address
Address - Class in com.onfido.models
Address.Request - Class in com.onfido.models
addressLine1(String) - Method in class com.onfido.models.DrivingLicence.Request: Line 1 of the address
addressLine2(String) - Method in class com.onfido.models.DrivingLicence.Request: Line 2 of the address
AddressManager - Class in com.onfido: Manager class for the Address resource type.
AddressManager(Config, OkHttpClient) - Constructor for class com.onfido.AddressManager
advancedValidation(Boolean) - Method in class com.onfido.models.LivePhoto.Request: Boolean flag for enabling advanced validation
ApiException - Exception in com.onfido.exceptions: Wrapper class for the error response returned from the Onfido API.
ApiJson<T> - Class in com.onfido.api: A wrapper around Moshi's JsonAdapter for parsing and formatting JSON for Onfido's API.
ApiJson(Class<T>) - Constructor for class com.onfido.api.ApiJson: Instantiates a new ApiJson object.
apiToken - Variable in class com.onfido.Onfido.Builder: The Api token.
apiToken(String) - Method in class com.onfido.Onfido.Builder: Api token attribute.
apiUrl - Variable in class com.onfido.Onfido.Builder: The Api url.
applicant - Variable in class com.onfido.Onfido: The manager class for the Applicant resource.
Applicant - Class in com.onfido.models
Applicant.Request - Class in com.onfido.models
applicantId(String) - Method in class com.onfido.models.Check.Request: The ID of the applicant to do the check on.
applicantId(String) - Method in class com.onfido.models.Document.Request: The ID of the associated applicant
applicantId(String) - Method in class com.onfido.models.LivePhoto.Request: The ID of the applicant
applicantId(String) - Method in class com.onfido.models.SdkToken.Request: Specifies the applicant for the SDK instance
ApplicantManager - Class in com.onfido: Manager class for the Applicant resource type.
ApplicantManager(Config, OkHttpClient) - Constructor for class com.onfido.ApplicantManager
applicantProvidesData(Boolean) - Method in class com.onfido.models.Check.Request: Send an applicant form to applicant to complete to proceed with check.
applicationId(String) - Method in class com.onfido.models.SdkToken.Request: The application ID (or “application bundle ID”) - used with the iOS and Android SDKs
asynchronous(Boolean) - Method in class com.onfido.models.Check.Request: Defaults to `true`.

B

build() - Method in class com.onfido.Onfido.Builder: Builds the Onfido object instance.
builder() - Static method in class com.onfido.Onfido: Gives access to the builder for the object.
buildingName(String) - Method in class com.onfido.models.Address.Request: The building name of this address
buildingNumber(String) - Method in class com.onfido.models.Address.Request: The building number of this address

C

cancel(String) - Method in class com.onfido.ReportManager: Cancels single paused reports.
check - Variable in class com.onfido.Onfido: The manager class for the Check resource.
Check - Class in com.onfido.models
Check.Request - Class in com.onfido.models
CheckManager - Class in com.onfido: Manager class for the Check resource type.
CheckManager(Config, OkHttpClient) - Constructor for class com.onfido.CheckManager
city(String) - Method in class com.onfido.models.DrivingLicence.Request: The city of the owner's address
clientInterceptor(Interceptor) - Method in class com.onfido.Onfido.Builder: Interceptor attribute.
clientProxy(Proxy) - Method in class com.onfido.Onfido.Builder: The proxy that will be used to configure the HttpClient with
clientReadTimeout(Duration) - Method in class com.onfido.Onfido.Builder: The read timeout duration that will be used to configure the HttpClient
com.onfido - package com.onfido
com.onfido.api - package com.onfido.api
com.onfido.exceptions - package com.onfido.exceptions
com.onfido.models - package com.onfido.models
com.onfido.webhooks - package com.onfido.webhooks
config - Variable in class com.onfido.Onfido: The Configuration for the instance.
Config - Class in com.onfido.api: The Configuration class for the Onfido object.
Config(Onfido.Builder) - Constructor for class com.onfido.api.Config: Instantiates a new Config.
consents(String...) - Method in class com.onfido.models.Applicant.Request: The applicant’s consents
consents(List<String>) - Method in class com.onfido.models.Applicant.Request: The applicant’s consents
consider(String...) - Method in class com.onfido.models.Check.Request: Triggers a pre-determined 'consider' report result in the sandbox for reports specified in the array.
consider(List<String>) - Method in class com.onfido.models.Check.Request: Triggers a pre-determined 'consider' report result in the sandbox for reports specified in the array.
content - Variable in class com.onfido.api.FileDownload: The content of the downloaded file.
contentType - Variable in class com.onfido.api.FileDownload: The file type of the associated content.
country(String) - Method in class com.onfido.models.Address.Request: The 3 character ISO country code of this address.
countryOfResidence(String) - Method in class com.onfido.models.Location.Request: The applicant's country of residence
create(Applicant.Request) - Method in class com.onfido.ApplicantManager: Creates a single applicant.
create(Check.Request) - Method in class com.onfido.CheckManager: Initiates a check for an applicant, which can contain one or more reports.
create(Webhook.Request) - Method in class com.onfido.WebhookManager: Registers a webhook.
crossDeviceUrl(String) - Method in class com.onfido.models.SdkToken.Request: Enterprise feature: The URL to be used for the cross device flow of the Web SDK

D

dateOfBirth(LocalDate) - Method in class com.onfido.models.DrivingLicence.Request: Date of birth in yyyy-mm-dd format
delete(String) - Method in class com.onfido.ApplicantManager: Deletes a single applicant.
delete(String) - Method in class com.onfido.WebhookManager: Deletes a webhook.
deleteRequest(String) - Method in class com.onfido.api.ResourceManager: Makes a DELETE http call to the specified path
dob(LocalDate) - Method in class com.onfido.models.Applicant.Request: The applicant’s date of birth
document - Variable in class com.onfido.Onfido: The manager class for the Document resource.
Document - Class in com.onfido.models
Document.Request - Class in com.onfido.models
documentCategory(String) - Method in class com.onfido.models.DrivingLicence.Request: Document category.
DocumentClassification - Class in com.onfido.models
DocumentClassification.Request - Class in com.onfido.models
DocumentId - Class in com.onfido.models
DocumentId.Request - Class in com.onfido.models
documentIds(String...) - Method in class com.onfido.models.Check.Request: An array of document ids (strings).
documentIds(List<String>) - Method in class com.onfido.models.Check.Request: An array of document ids (strings).
DocumentManager - Class in com.onfido: Manager class for the Document resource type.
DocumentManager(Config, OkHttpClient) - Constructor for class com.onfido.DocumentManager
download(String) - Method in class com.onfido.CheckManager: Downloads a check.
download(String) - Method in class com.onfido.DocumentManager: Downloads specific documents belonging to an applicant.
download(String) - Method in class com.onfido.LivePhotoManager: Downloads a live photo.
download(String) - Method in class com.onfido.LiveVideoManager: Downloads a live video.
downloadFrame(String) - Method in class com.onfido.LiveVideoManager: Instead of the whole video, a single frame can be downloaded.
downloadRequest(String) - Method in class com.onfido.api.ResourceManager: Makes a GET http call to the specified path
DrivingLicence - Class in com.onfido.models
DrivingLicence.Request - Class in com.onfido.models

E

email(String) - Method in class com.onfido.models.Applicant.Request: The applicant’s email address.
enabled(Boolean) - Method in class com.onfido.models.Webhook.Request: Determines if the webhook should be active.
environments(String...) - Method in class com.onfido.models.Webhook.Request: The environments to be used
environments(List<String>) - Method in class com.onfido.models.Webhook.Request: The environments to be used
equals(Object) - Method in class com.onfido.models.Address
equals(Object) - Method in class com.onfido.models.Applicant
equals(Object) - Method in class com.onfido.models.Check
equals(Object) - Method in class com.onfido.models.Document
equals(Object) - Method in class com.onfido.models.DocumentClassification
equals(Object) - Method in class com.onfido.models.DocumentId
equals(Object) - Method in class com.onfido.models.DrivingLicence
equals(Object) - Method in class com.onfido.models.ExtractedData
equals(Object) - Method in class com.onfido.models.Extraction
equals(Object) - Method in class com.onfido.models.IdNumber
equals(Object) - Method in class com.onfido.models.LivePhoto
equals(Object) - Method in class com.onfido.models.LiveVideo
equals(Object) - Method in class com.onfido.models.Location
equals(Object) - Method in class com.onfido.models.Report
equals(Object) - Method in class com.onfido.models.SdkToken
equals(Object) - Method in class com.onfido.models.Webhook
equals(Object) - Method in class com.onfido.webhooks.WebhookEvent
equals(Object) - Method in class com.onfido.webhooks.WebhookEventObject
events(String...) - Method in class com.onfido.models.Webhook.Request: The events that should be published to the webhook.
events(List<String>) - Method in class com.onfido.models.Webhook.Request: The events that should be published to the webhook.
expirationDate(LocalDate) - Method in class com.onfido.models.DrivingLicence.Request: Expiration date of the driving licence in yyyy-mm-dd format
ExtractedData - Class in com.onfido.models
ExtractedData.Request - Class in com.onfido.models
extraction - Variable in class com.onfido.Onfido: The manager class for the Extraction resource.
Extraction - Class in com.onfido.models
Extraction.Request - Class in com.onfido.models
ExtractionManager - Class in com.onfido: Manager class for the Extraction resource type.
ExtractionManager(Config, OkHttpClient) - Constructor for class com.onfido.ExtractionManager
eyeColorCode(String) - Method in class com.onfido.models.DrivingLicence.Request: Eye color code.

F

FileDownload - Class in com.onfido.api: A wrapper class for any file downloaded from the API.
FileDownload(byte[], String) - Constructor for class com.onfido.api.FileDownload: Instantiates a new File download object.
find(String) - Method in class com.onfido.ApplicantManager: Retrieves a single applicant.
find(String) - Method in class com.onfido.CheckManager: Retrieves a single check.
find(String) - Method in class com.onfido.DocumentManager: Retrieves a single document.
find(String) - Method in class com.onfido.LivePhotoManager: Retrieves a single live photo.
find(String) - Method in class com.onfido.LiveVideoManager: Retrieves a single live video.
find(String) - Method in class com.onfido.ReportManager: Retrieves a single report.
find(String) - Method in class com.onfido.WebhookManager: Retrieves a single webhook.
firstName(String) - Method in class com.onfido.models.Applicant.Request: The applicant’s first name
firstName(String) - Method in class com.onfido.models.DrivingLicence.Request: The owner’s first name
flatNumber(String) - Method in class com.onfido.models.Address.Request: The flat number of this address
fromResponseBody(String, int) - Static method in exception com.onfido.exceptions.ApiException: Extracts an exception from the response body.

G

generate(SdkToken.Request) - Method in class com.onfido.SdkTokenManager: Generate an SDK token.
get(String) - Method in class com.onfido.api.ResourceManager: Makes a GET http call to the specified path
getAction() - Method in class com.onfido.webhooks.WebhookEvent: Gets the action.
getAddress() - Method in class com.onfido.models.Applicant: The applicants address
getAddress() - Method in class com.onfido.models.Applicant.Request: The applicants address
getAddressLine1() - Method in class com.onfido.models.DrivingLicence: Line 1 of the address
getAddressLine1() - Method in class com.onfido.models.DrivingLicence.Request: Line 1 of the address
getAddressLine1() - Method in class com.onfido.models.ExtractedData: Line 1 of the address
getAddressLine2() - Method in class com.onfido.models.DrivingLicence: Line 2 of the address
getAddressLine2() - Method in class com.onfido.models.DrivingLicence.Request: Line 2 of the address
getAddressLine2() - Method in class com.onfido.models.ExtractedData: Line 2 of the address
getAddressLine3() - Method in class com.onfido.models.ExtractedData: Line 3 of the address
getAddressLine4() - Method in class com.onfido.models.ExtractedData: Line 4 of the address
getAddressLine5() - Method in class com.onfido.models.ExtractedData: Line 5 of the address
getAdvancedValidation() - Method in class com.onfido.models.LivePhoto: Boolean flag for enabling advanced validation
getAdvancedValidation() - Method in class com.onfido.models.LivePhoto.Request: Boolean flag for enabling advanced validation
getApiToken() - Method in class com.onfido.api.Config: Gets the api token.
getApiUrl() - Method in class com.onfido.api.Config: Gets the api url.
getApplicantId() - Method in class com.onfido.models.Check: The ID of the applicant to do the check on.
getApplicantId() - Method in class com.onfido.models.Check.Request: The ID of the applicant to do the check on.
getApplicantId() - Method in class com.onfido.models.Document.Request: The ID of the associated applicant
getApplicantId() - Method in class com.onfido.models.LivePhoto: The ID of the applicant
getApplicantId() - Method in class com.onfido.models.LivePhoto.Request: The ID of the applicant
getApplicantId() - Method in class com.onfido.models.SdkToken.Request: Specifies the applicant for the SDK instance
getApplicantProvidesData() - Method in class com.onfido.models.Check.Request: Send an applicant form to applicant to complete to proceed with check.
getApplicationId() - Method in class com.onfido.models.SdkToken.Request: The application ID (or “application bundle ID”) - used with the iOS and Android SDKs
getAsynchronous() - Method in class com.onfido.models.Check.Request: Defaults to `true`.
getBreakdown() - Method in class com.onfido.models.Report: The details of the report.
getBuildingName() - Method in class com.onfido.models.Address: The building name of this address
getBuildingName() - Method in class com.onfido.models.Address.Request: The building name of this address
getBuildingNumber() - Method in class com.onfido.models.Address: The building number of this address
getBuildingNumber() - Method in class com.onfido.models.Address.Request: The building number of this address
getChallenge() - Method in class com.onfido.models.LiveVideo: Challenge the end user was asked to perform during the video recording
getCheckId() - Method in class com.onfido.models.Report: The ID of the check to which the report belongs.
getCity() - Method in class com.onfido.models.DrivingLicence: The city of the owner's address
getCity() - Method in class com.onfido.models.DrivingLicence.Request: The city of the owner's address
getCompletedAtIso8601() - Method in class com.onfido.webhooks.WebhookEventObject: Gets completed at iso 8601.
getConsents() - Method in class com.onfido.models.Applicant.Request: The applicant’s consents
getConsider() - Method in class com.onfido.models.Check.Request: Triggers a pre-determined 'consider' report result in the sandbox for reports specified in the array.
getCountry() - Method in class com.onfido.models.Address: The 3 character ISO country code of this address.
getCountry() - Method in class com.onfido.models.Address.Request: The 3 character ISO country code of this address.
getCountryOfResidence() - Method in class com.onfido.models.Location: The applicant's country of residence
getCountryOfResidence() - Method in class com.onfido.models.Location.Request: The applicant's country of residence
getCreatedAt() - Method in class com.onfido.models.Applicant: The date and time when this applicant was created.
getCreatedAt() - Method in class com.onfido.models.Check: The date and time when this check was created.
getCreatedAt() - Method in class com.onfido.models.Document: The date and time at which the document was uploaded
getCreatedAt() - Method in class com.onfido.models.LivePhoto: The date and time at which the live photo was uploaded
getCreatedAt() - Method in class com.onfido.models.LiveVideo: The date and time at which the live photo was uploaded
getCreatedAt() - Method in class com.onfido.models.Report: The date and time at which the report was first initiated
getCrossDeviceUrl() - Method in class com.onfido.models.SdkToken.Request: Enterprise feature: The URL to be used for the cross device flow of the Web SDK
getDateOfBirth() - Method in class com.onfido.models.DrivingLicence: Date of birth in yyyy-mm-dd format
getDateOfBirth() - Method in class com.onfido.models.DrivingLicence.Request: Date of birth in yyyy-mm-dd format
getDateOfBirth() - Method in class com.onfido.models.ExtractedData: Date of birth in yyyy-mm-dd format
getDateOfExpiry() - Method in class com.onfido.models.ExtractedData: Date of expiry in yyyy-mm-dd format
getDeleteAt() - Method in class com.onfido.models.Applicant: The date and time when this applicant is scheduled to be deleted.
getDob() - Method in class com.onfido.models.Applicant: The applicant’s date of birth
getDob() - Method in class com.onfido.models.Applicant.Request: The applicant’s date of birth
getDocumentCategory() - Method in class com.onfido.models.DrivingLicence: Document category.
getDocumentCategory() - Method in class com.onfido.models.DrivingLicence.Request: Document category.
getDocumentClassification() - Method in class com.onfido.models.Extraction: The document classification
getDocumentId() - Method in class com.onfido.models.Extraction: The unique identifier of the uploaded document to run extraction on
getDocumentIds() - Method in class com.onfido.models.Check.Request: An array of document ids (strings).
getDocumentNumber() - Method in class com.onfido.models.ExtractedData: The official document number
getDocuments() - Method in class com.onfido.models.Report: The document IDs that were processed.
getDocumentType() - Method in class com.onfido.models.DocumentClassification: The type of document
getDownloadHref() - Method in class com.onfido.models.Document: The uri that can be used to download the document
getDownloadHref() - Method in class com.onfido.models.LivePhoto: The URI that can be used to download the live photo
getDownloadHref() - Method in class com.onfido.models.LiveVideo: The URI that can be used to download the live photo
getDownloadUri() - Method in class com.onfido.models.Check: A link to a PDF output of the check results.
getEmail() - Method in class com.onfido.models.Applicant: The applicant’s email address.
getEmail() - Method in class com.onfido.models.Applicant.Request: The applicant’s email address.
getEnabled() - Method in class com.onfido.models.Webhook: Determines if the webhook should be active.
getEnabled() - Method in class com.onfido.models.Webhook.Request: Determines if the webhook should be active.
getEnvironments() - Method in class com.onfido.models.Webhook: The environments to be used
getEnvironments() - Method in class com.onfido.models.Webhook.Request: The environments to be used
getEvents() - Method in class com.onfido.models.Webhook: The events that should be published to the webhook.
getEvents() - Method in class com.onfido.models.Webhook.Request: The events that should be published to the webhook.
getExpirationDate() - Method in class com.onfido.models.DrivingLicence: Expiration date of the driving licence in yyyy-mm-dd format
getExpirationDate() - Method in class com.onfido.models.DrivingLicence.Request: Expiration date of the driving licence in yyyy-mm-dd format
getExtractedData() - Method in class com.onfido.models.Extraction: As extraction is done on a best-effort basis, and also information varies across different documents, none of these properties are guaranteed be present in the response.
getEyeColorCode() - Method in class com.onfido.models.DrivingLicence: Eye color code.
getEyeColorCode() - Method in class com.onfido.models.DrivingLicence.Request: Eye color code.
getFields() - Method in exception com.onfido.exceptions.ApiException: Gets fields.
getFileName() - Method in class com.onfido.models.Document: The name of the uploaded file
getFileName() - Method in class com.onfido.models.LivePhoto: The name of the uploaded file
getFileName() - Method in class com.onfido.models.LiveVideo: The name of the uploaded file
getFileSize() - Method in class com.onfido.models.Document: The size of the file in bytes
getFileSize() - Method in class com.onfido.models.LivePhoto: The size of the file in bytes
getFileSize() - Method in class com.onfido.models.LiveVideo: The size of the file in bytes
getFileType() - Method in class com.onfido.models.Document: The file type of the uploaded file
getFileType() - Method in class com.onfido.models.LivePhoto: The file type of the uploaded file
getFileType() - Method in class com.onfido.models.LiveVideo: The file type of the uploaded file
getFirstName() - Method in class com.onfido.models.Applicant: The applicant’s first name
getFirstName() - Method in class com.onfido.models.Applicant.Request: The applicant’s first name
getFirstName() - Method in class com.onfido.models.DrivingLicence: The owner’s first name
getFirstName() - Method in class com.onfido.models.DrivingLicence.Request: The owner’s first name
getFirstName() - Method in class com.onfido.models.ExtractedData: First name
getFlatNumber() - Method in class com.onfido.models.Address: The flat number of this address
getFlatNumber() - Method in class com.onfido.models.Address.Request: The flat number of this address
getFormUri() - Method in class com.onfido.models.Check: A link to the applicant form, if `applicant_provides_data` is `true`.
getFullName() - Method in class com.onfido.models.ExtractedData: Full name
getGender() - Method in class com.onfido.models.DrivingLicence: Gender.
getGender() - Method in class com.onfido.models.ExtractedData: Gender.
getHeightMeasureFeet() - Method in class com.onfido.models.DrivingLicence: Height, feet
getHeightMeasureInches() - Method in class com.onfido.models.DrivingLicence: Height, inches
getHref() - Method in class com.onfido.models.Applicant: The uri of this resource.
getHref() - Method in class com.onfido.models.Check: The uri of this resource.
getHref() - Method in class com.onfido.models.Document: The uri of this resource
getHref() - Method in class com.onfido.models.LivePhoto: The URI of this resource
getHref() - Method in class com.onfido.models.LiveVideo: The URI of this resource
getHref() - Method in class com.onfido.models.Report: The API endpoint to retrieve the report
getHref() - Method in class com.onfido.models.Webhook: The URI of this resource
getHref() - Method in class com.onfido.webhooks.WebhookEventObject: Gets href.
getId() - Method in class com.onfido.models.Applicant: The unique identifier for the applicant.
getId() - Method in class com.onfido.models.Check: The unique identifier for the check.
getId() - Method in class com.onfido.models.Document: The unique identifier for the document
getId() - Method in class com.onfido.models.DocumentId: The unique identifier for the document
getId() - Method in class com.onfido.models.LivePhoto: The unique identifier of the live photo
getId() - Method in class com.onfido.models.LiveVideo: The unique identifier of the live photo
getId() - Method in class com.onfido.models.Report: The unique identifier for the report
getId() - Method in class com.onfido.models.Webhook: The unique identifier for the webhook
getId() - Method in class com.onfido.webhooks.WebhookEventObject: Gets id.
getIdNumber() - Method in class com.onfido.models.DrivingLicence: Driving licence ID number
getIdNumber() - Method in class com.onfido.models.DrivingLicence.Request: Driving licence ID number
getIdNumbers() - Method in class com.onfido.models.Applicant: The applicants ID numbers
getIdNumbers() - Method in class com.onfido.models.Applicant.Request: The applicants ID numbers
getIpAddress() - Method in class com.onfido.models.Location: The applicant's ip address
getIpAddress() - Method in class com.onfido.models.Location.Request: The applicant's ip address
getIssueDate() - Method in class com.onfido.models.DrivingLicence: Issue date in yyyy-mm-dd format
getIssueDate() - Method in class com.onfido.models.DrivingLicence.Request: Issue date in yyyy-mm-dd format
getIssuingCountry() - Method in class com.onfido.models.Document: The issuing country of the document, a 3-letter ISO code.
getIssuingCountry() - Method in class com.onfido.models.Document.Request: The issuing country of the document, a 3-letter ISO code.
getIssuingCountry() - Method in class com.onfido.models.DocumentClassification: Document country in 3-letter ISO code
getIssuingState() - Method in class com.onfido.models.DocumentClassification: The state that issued the document
getLastName() - Method in class com.onfido.models.Applicant: The applicant’s surname
getLastName() - Method in class com.onfido.models.Applicant.Request: The applicant’s surname
getLastName() - Method in class com.onfido.models.DrivingLicence: The owner’s surname
getLastName() - Method in class com.onfido.models.DrivingLicence.Request: The owner’s surname
getLastName() - Method in class com.onfido.models.ExtractedData: Last name
getLine1() - Method in class com.onfido.models.Address: Line 1 of the address (ID Enhanced reports).
getLine1() - Method in class com.onfido.models.Address.Request: Line 1 of the address (ID Enhanced reports).
getLine2() - Method in class com.onfido.models.Address: Line 2 of the address (ID Enhanced reports).
getLine2() - Method in class com.onfido.models.Address.Request: Line 2 of the address (ID Enhanced reports).
getLine3() - Method in class com.onfido.models.Address: Line 3 of the address (ID Enhanced reports).
getLine3() - Method in class com.onfido.models.Address.Request: Line 3 of the address (ID Enhanced reports).
getLocation() - Method in class com.onfido.models.Applicant: The applicant's location
getLocation() - Method in class com.onfido.models.Applicant.Request: The applicant's location
getLocation() - Method in class com.onfido.models.Document.Request: The applicant's location
getMessage() - Method in exception com.onfido.exceptions.ApiException
getMiddleName() - Method in class com.onfido.models.DrivingLicence: The owner’s middle name
getMiddleName() - Method in class com.onfido.models.DrivingLicence.Request: The owner’s middle name
getMiddleName() - Method in class com.onfido.models.ExtractedData: Middle name
getMrzLine1() - Method in class com.onfido.models.ExtractedData: Line 1 of the MRZ code
getMrzLine2() - Method in class com.onfido.models.ExtractedData: Line 2 of the MRZ code
getMrzLine3() - Method in class com.onfido.models.ExtractedData: Line 3 of the MRZ code
getName() - Method in class com.onfido.models.Report: Report type string identifier.
getName() - Method in class com.onfido.models.Report.Request: Report type string identifier.
getNameSuffix() - Method in class com.onfido.models.DrivingLicence: The owner’s name suffix
getNameSuffix() - Method in class com.onfido.models.DrivingLicence.Request: The owner’s name suffix
getNationality() - Method in class com.onfido.models.ExtractedData: Nationality in 3-letter ISO code
getObject() - Method in class com.onfido.webhooks.WebhookEvent: Gets the event object.
getPayload() - Method in class com.onfido.webhooks.WebhookPayload: Gets Webhook payload.
getPhoneNumber() - Method in class com.onfido.models.Applicant: The applicant’s phone number
getPhoneNumber() - Method in class com.onfido.models.Applicant.Request: The applicant’s phone number
getPostalCode() - Method in class com.onfido.models.DrivingLicence: The postcode or ZIP of the owner’s address
getPostalCode() - Method in class com.onfido.models.DrivingLicence.Request: The postcode or ZIP of the owner’s address
getPostcode() - Method in class com.onfido.models.Address: The postcode or ZIP of the applicant’s address
getPostcode() - Method in class com.onfido.models.Address.Request: The postcode or ZIP of the applicant’s address
getPrivacyNoticesReadConsentGiven() - Method in class com.onfido.models.Check: Indicates that the privacy notices and terms of service have been read and, where specific laws require, that consent has been given for Onfido.
getPrivacyNoticesReadConsentGiven() - Method in class com.onfido.models.Check.Request: Indicates that the privacy notices and terms of service have been read and, where specific laws require, that consent has been given for Onfido.
getProperties() - Method in class com.onfido.models.Report: The properties associated with the report, if any
getRedirectUri() - Method in class com.onfido.models.Check: For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
getRedirectUri() - Method in class com.onfido.models.Check.Request: For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
getReferrer() - Method in class com.onfido.models.SdkToken.Request: The referrer URL pattern - used with the Web SDK
getReportIds() - Method in class com.onfido.models.Check: The list of report object ids associated with the check.
getReportNames() - Method in class com.onfido.models.Check.Request: An array of report names (strings).
getResourceType() - Method in class com.onfido.webhooks.WebhookEvent: Gets resource type.
getResult() - Method in class com.onfido.models.Check: The overall result of the check, based on the results of the constituent reports.
getResult() - Method in class com.onfido.models.Report: The result of the report
getResult() - Method in class com.onfido.models.Report.Request: The result of the report
getResultsUri() - Method in class com.onfido.models.Check: A link to the corresponding results page on the Onfido dashboard.
getSandbox() - Method in class com.onfido.models.Applicant: Read-only.
getSide() - Method in class com.onfido.models.Document: The side of the document, if applicable.
getSide() - Method in class com.onfido.models.Document.Request: The side of the document, if applicable.
getState() - Method in class com.onfido.models.Address: The address state.
getState() - Method in class com.onfido.models.Address.Request: The address state.
getState() - Method in class com.onfido.models.DrivingLicence: The state of the owner's address.
getState() - Method in class com.onfido.models.DrivingLicence.Request: The state of the owner's address.
getStateCode() - Method in class com.onfido.models.DrivingLicence: Two letter code of issuing state (state-issued driving licenses only)
getStateCode() - Method in class com.onfido.models.DrivingLicence.Request: Two letter code of issuing state (state-issued driving licenses only)
getStateCode() - Method in class com.onfido.models.IdNumber: Two letter code of issuing state (state-issued driving licenses only)
getStateCode() - Method in class com.onfido.models.IdNumber.Request: Two letter code of issuing state (state-issued driving licenses only)
getStatus() - Method in class com.onfido.models.Check: The current state of the check in the checking process.
getStatus() - Method in class com.onfido.models.Report: The current state of the report in the checking process
getStatus() - Method in class com.onfido.webhooks.WebhookEventObject: Gets status.
getStatusCode() - Method in exception com.onfido.exceptions.ApiException: Gets status code.
getStreet() - Method in class com.onfido.models.Address: The street of the applicant’s address
getStreet() - Method in class com.onfido.models.Address.Request: The street of the applicant’s address
getSubResult() - Method in class com.onfido.models.Check.Request: Triggers responses for particular sub-results for sandbox Document reports.
getSubResult() - Method in class com.onfido.models.Report: The sub_result of the report.
getSubStreet() - Method in class com.onfido.models.Address: The sub-street of the applicant’s address
getSubStreet() - Method in class com.onfido.models.Address.Request: The sub-street of the applicant’s address
getSuppressFormEmails() - Method in class com.onfido.models.Check.Request: For checks where `applicant_provides_data` is `true`, applicant form will not be automatically sent if `suppress_form_emails` is set to `true`.
getTags() - Method in class com.onfido.models.Check: Array of tags being assigned to this check.
getTags() - Method in class com.onfido.models.Check.Request: Array of tags being assigned to this check.
getToken() - Method in class com.onfido.models.SdkToken: The generated token
getToken() - Method in class com.onfido.models.Webhook: The webhook token (read more about this in the “Webhook security” section
getTown() - Method in class com.onfido.models.Address: The town of the applicant’s address
getTown() - Method in class com.onfido.models.Address.Request: The town of the applicant’s address
getType() - Method in exception com.onfido.exceptions.ApiException: Gets type.
getType() - Method in class com.onfido.models.Document: The type of document
getType() - Method in class com.onfido.models.Document.Request: The type of document
getType() - Method in class com.onfido.models.IdNumber: Type of ID number.
getType() - Method in class com.onfido.models.IdNumber.Request: Type of ID number.
getUrl() - Method in class com.onfido.models.Webhook: The url to listen to notifications (must be HTTPS)
getUrl() - Method in class com.onfido.models.Webhook.Request: The url to listen to notifications (must be HTTPS)
getUsDrivingLicence() - Method in class com.onfido.models.Check.Request: An object that contains all accepted fields for the Driver's License Data Verification report.
getValidateImageQuality() - Method in class com.onfido.models.Document.Request: When true the submitted image will undergo an image quality validation
getValue() - Method in class com.onfido.models.IdNumber: Value of ID number
getValue() - Method in class com.onfido.models.IdNumber.Request: Value of ID number
getWebhookIds() - Method in class com.onfido.models.Check: Array of strings describing which webhooks to trigger for a check.
getWebhookIds() - Method in class com.onfido.models.Check.Request: Array of strings describing which webhooks to trigger for a check.
getWeightMeasure() - Method in class com.onfido.models.DrivingLicence: Weight in pounds
getWeightMeasure() - Method in class com.onfido.models.DrivingLicence.Request: Weight in pounds

H

hashCode() - Method in class com.onfido.models.Address
hashCode() - Method in class com.onfido.models.Applicant
hashCode() - Method in class com.onfido.models.Check
hashCode() - Method in class com.onfido.models.Document
hashCode() - Method in class com.onfido.models.DocumentClassification
hashCode() - Method in class com.onfido.models.DocumentId
hashCode() - Method in class com.onfido.models.DrivingLicence
hashCode() - Method in class com.onfido.models.ExtractedData
hashCode() - Method in class com.onfido.models.Extraction
hashCode() - Method in class com.onfido.models.IdNumber
hashCode() - Method in class com.onfido.models.LivePhoto
hashCode() - Method in class com.onfido.models.LiveVideo
hashCode() - Method in class com.onfido.models.Location
hashCode() - Method in class com.onfido.models.Report
hashCode() - Method in class com.onfido.models.SdkToken
hashCode() - Method in class com.onfido.models.Webhook
hashCode() - Method in class com.onfido.webhooks.WebhookEvent
hashCode() - Method in class com.onfido.webhooks.WebhookEventObject

I

idNumber(String) - Method in class com.onfido.models.DrivingLicence.Request: Driving licence ID number
IdNumber - Class in com.onfido.models
IdNumber.Request - Class in com.onfido.models
idNumbers(IdNumber.Request...) - Method in class com.onfido.models.Applicant.Request: The applicants ID numbers
idNumbers(List<IdNumber.Request>) - Method in class com.onfido.models.Applicant.Request: The applicants ID numbers
ipAddress(String) - Method in class com.onfido.models.Location.Request: The applicant's ip address
isClientError() - Method in exception com.onfido.exceptions.ApiException: Is client error boolean.
issueDate(LocalDate) - Method in class com.onfido.models.DrivingLicence.Request: Issue date in yyyy-mm-dd format
issuingCountry(String) - Method in class com.onfido.models.Document.Request: The issuing country of the document, a 3-letter ISO code.

L

lastName(String) - Method in class com.onfido.models.Applicant.Request: The applicant’s surname
lastName(String) - Method in class com.onfido.models.DrivingLicence.Request: The owner’s surname
line1(String) - Method in class com.onfido.models.Address.Request: Line 1 of the address (ID Enhanced reports).
line2(String) - Method in class com.onfido.models.Address.Request: Line 2 of the address (ID Enhanced reports).
line3(String) - Method in class com.onfido.models.Address.Request: Line 3 of the address (ID Enhanced reports).
list() - Method in class com.onfido.WebhookManager: Lists all webhooks you’ve created.
list(int, int, boolean) - Method in class com.onfido.ApplicantManager: Lists all applicants you’ve created, sorted by creation date in descending order.
list(String) - Method in class com.onfido.CheckManager: Returns all checks for an applicant.
list(String) - Method in class com.onfido.DocumentManager: Lists all documents belonging to an applicant.
list(String) - Method in class com.onfido.LivePhotoManager: Lists the live photos that belong to an applicant.
list(String) - Method in class com.onfido.LiveVideoManager: Lists all the live videos that belong to an applicant.
list(String) - Method in class com.onfido.ReportManager: Lists all reports belonging to a particular check.
livePhoto - Variable in class com.onfido.Onfido: The manager class for the Live photo resource.
LivePhoto - Class in com.onfido.models
LivePhoto.Request - Class in com.onfido.models
LivePhotoManager - Class in com.onfido: Manager class for the Live photo resource type.
LivePhotoManager(Config, OkHttpClient) - Constructor for class com.onfido.LivePhotoManager
liveVideo - Variable in class com.onfido.Onfido: The manager class for the Live video resource.
LiveVideo - Class in com.onfido.models
LiveVideo.Request - Class in com.onfido.models
LiveVideoManager - Class in com.onfido: Manager class for the Live video resource type.
LiveVideoManager(Config, OkHttpClient) - Constructor for class com.onfido.LiveVideoManager
location(Location.Request) - Method in class com.onfido.models.Applicant.Request: The applicant's location
location(Location.Request) - Method in class com.onfido.models.Document.Request: The applicant's location
Location - Class in com.onfido.models
Location.Request - Class in com.onfido.models

M

middleName(String) - Method in class com.onfido.models.DrivingLicence.Request: The owner’s middle name

N

name(String) - Method in class com.onfido.models.Report.Request: Report type string identifier.
nameSuffix(String) - Method in class com.onfido.models.DrivingLicence.Request: The owner’s name suffix
networkError(Throwable) - Static method in exception com.onfido.exceptions.OnfidoException: Throws a new OnfidoException with a network timeout message.

O

Onfido - Class in com.onfido: The main class used for accessing instances of the manager classes.
Onfido.Builder - Class in com.onfido: The Builder for the Onfido object.
OnfidoException - Exception in com.onfido.exceptions: An exception thrown by this client library.
OnfidoException(String) - Constructor for exception com.onfido.exceptions.OnfidoException: Instantiates a new OnfidoException.
OnfidoException(String, Throwable) - Constructor for exception com.onfido.exceptions.OnfidoException: Instantiates a new OnfidoException.

P

parse(String) - Method in class com.onfido.api.ApiJson: Coverts the provided json string to an object of type T
parseWrappedList(String, String) - Method in class com.onfido.api.ApiJson: Parses a json array into a list of type T.
perform(String) - Method in class com.onfido.ExtractionManager: Initiates an extraction for a document.
phoneNumber(String) - Method in class com.onfido.models.Applicant.Request: The applicant’s phone number
pick(String) - Method in class com.onfido.AddressManager: Performs a search for addresses by postcode (UK only).
post(String, String) - Method in class com.onfido.api.ResourceManager: Makes a POST http call to the specified path and request body.
postalCode(String) - Method in class com.onfido.models.DrivingLicence.Request: The postcode or ZIP of the owner’s address
postcode(String) - Method in class com.onfido.models.Address.Request: The postcode or ZIP of the applicant’s address
privacyNoticesReadConsentGiven(Boolean) - Method in class com.onfido.models.Check.Request: Indicates that the privacy notices and terms of service have been read and, where specific laws require, that consent has been given for Onfido.
put(String, String) - Method in class com.onfido.api.ResourceManager: Makes a PUT http call to the specified path and request body.

R

readInputStream(InputStream) - Method in class com.onfido.api.ResourceManager: Converts an InputStream to a byte[] to be sent as part of a multipart request body
readPayload(String, String) - Method in class com.onfido.webhooks.WebhookEventVerifier: Takes in a webhook response and signature and verifies it against the instance's token
redirectUri(String) - Method in class com.onfido.models.Check.Request: For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
referrer(String) - Method in class com.onfido.models.SdkToken.Request: The referrer URL pattern - used with the Web SDK
regionCA() - Method in class com.onfido.Onfido.Builder: Sets the object to use the Canada region base URL.
regionEU() - Method in class com.onfido.Onfido.Builder: Sets the object to use the EU region base URL.
regionUS() - Method in class com.onfido.Onfido.Builder: Sets the object to use the US region base URL.
report - Variable in class com.onfido.Onfido: The manager class for the Report resource.
Report - Class in com.onfido.models
Report.Request - Class in com.onfido.models
ReportManager - Class in com.onfido: Manager class for the Report resource type.
ReportManager(Config, OkHttpClient) - Constructor for class com.onfido.ReportManager
reportNames(String...) - Method in class com.onfido.models.Check.Request: An array of report names (strings).
reportNames(List<String>) - Method in class com.onfido.models.Check.Request: An array of report names (strings).
request() - Static method in class com.onfido.models.Address
request() - Static method in class com.onfido.models.Applicant
request() - Static method in class com.onfido.models.Check
request() - Static method in class com.onfido.models.Document
request() - Static method in class com.onfido.models.DocumentClassification
request() - Static method in class com.onfido.models.DocumentId
request() - Static method in class com.onfido.models.DrivingLicence
request() - Static method in class com.onfido.models.ExtractedData
request() - Static method in class com.onfido.models.Extraction
request() - Static method in class com.onfido.models.IdNumber
request() - Static method in class com.onfido.models.LivePhoto
request() - Static method in class com.onfido.models.LiveVideo
request() - Static method in class com.onfido.models.Location
request() - Static method in class com.onfido.models.Report
request() - Static method in class com.onfido.models.SdkToken
request() - Static method in class com.onfido.models.Webhook
ResourceManager - Class in com.onfido.api: Manager class for all resource types.
ResourceManager(String, Config, OkHttpClient) - Constructor for class com.onfido.api.ResourceManager
restore(String) - Method in class com.onfido.ApplicantManager: Restores a single applicant scheduled for deletion.
result(String) - Method in class com.onfido.models.Report.Request: The result of the report
resume(String) - Method in class com.onfido.CheckManager: Resumes a paused check.
resume(String) - Method in class com.onfido.ReportManager: Resumes a single paused report.

S

sdkToken - Variable in class com.onfido.Onfido: The manager class for the Sdk token resource.
SdkToken - Class in com.onfido.models
SdkToken.Request - Class in com.onfido.models
SdkTokenManager - Class in com.onfido: Manager class for the Sdk token resource type.
SdkTokenManager(Config, OkHttpClient) - Constructor for class com.onfido.SdkTokenManager
shutdown() - Static method in class com.onfido.Onfido: Shuts down the client across all Onfido instances, causing all future API calls to be rejected.
side(String) - Method in class com.onfido.models.Document.Request: The side of the document, if applicable.
state(String) - Method in class com.onfido.models.Address.Request: The address state.
state(String) - Method in class com.onfido.models.DrivingLicence.Request: The state of the owner's address.
stateCode(String) - Method in class com.onfido.models.DrivingLicence.Request: Two letter code of issuing state (state-issued driving licenses only)
stateCode(String) - Method in class com.onfido.models.IdNumber.Request: Two letter code of issuing state (state-issued driving licenses only)
street(String) - Method in class com.onfido.models.Address.Request: The street of the applicant’s address
subResult(String) - Method in class com.onfido.models.Check.Request: Triggers responses for particular sub-results for sandbox Document reports.
subStreet(String) - Method in class com.onfido.models.Address.Request: The sub-street of the applicant’s address
suppressFormEmails(Boolean) - Method in class com.onfido.models.Check.Request: For checks where `applicant_provides_data` is `true`, applicant form will not be automatically sent if `suppress_form_emails` is set to `true`.

T

tags(String...) - Method in class com.onfido.models.Check.Request: Array of tags being assigned to this check.
tags(List<String>) - Method in class com.onfido.models.Check.Request: Array of tags being assigned to this check.
toJson() - Method in class com.onfido.models.Address.Request
toJson() - Method in class com.onfido.models.Applicant.Request
toJson() - Method in class com.onfido.models.Check.Request
toJson() - Method in class com.onfido.models.Document.Request
toJson() - Method in class com.onfido.models.DocumentClassification.Request
toJson() - Method in class com.onfido.models.DocumentId.Request
toJson() - Method in class com.onfido.models.DrivingLicence.Request
toJson() - Method in class com.onfido.models.ExtractedData.Request
toJson() - Method in class com.onfido.models.Extraction.Request
toJson() - Method in class com.onfido.models.IdNumber.Request
toJson() - Method in class com.onfido.models.LivePhoto.Request
toJson() - Method in class com.onfido.models.LiveVideo.Request
toJson() - Method in class com.onfido.models.Location.Request
toJson() - Method in class com.onfido.models.Report.Request
toJson() - Method in class com.onfido.models.SdkToken.Request
toJson() - Method in class com.onfido.models.Webhook.Request
toJson(T) - Method in class com.onfido.api.ApiJson: Coverts the provided object of type T to a json string.
toPrettyJson(T) - Method in class com.onfido.api.ApiJson: Coverts the provided object of type T to a human readable json string.
toString() - Method in class com.onfido.models.Address.Request
toString() - Method in class com.onfido.models.Address
toString() - Method in class com.onfido.models.Applicant.Request
toString() - Method in class com.onfido.models.Applicant
toString() - Method in class com.onfido.models.Check.Request
toString() - Method in class com.onfido.models.Check
toString() - Method in class com.onfido.models.Document.Request
toString() - Method in class com.onfido.models.Document
toString() - Method in class com.onfido.models.DocumentClassification.Request
toString() - Method in class com.onfido.models.DocumentClassification
toString() - Method in class com.onfido.models.DocumentId.Request
toString() - Method in class com.onfido.models.DocumentId
toString() - Method in class com.onfido.models.DrivingLicence.Request
toString() - Method in class com.onfido.models.DrivingLicence
toString() - Method in class com.onfido.models.ExtractedData.Request
toString() - Method in class com.onfido.models.ExtractedData
toString() - Method in class com.onfido.models.Extraction.Request
toString() - Method in class com.onfido.models.Extraction
toString() - Method in class com.onfido.models.IdNumber.Request
toString() - Method in class com.onfido.models.IdNumber
toString() - Method in class com.onfido.models.LivePhoto.Request
toString() - Method in class com.onfido.models.LivePhoto
toString() - Method in class com.onfido.models.LiveVideo.Request
toString() - Method in class com.onfido.models.LiveVideo
toString() - Method in class com.onfido.models.Location.Request
toString() - Method in class com.onfido.models.Location
toString() - Method in class com.onfido.models.Report.Request
toString() - Method in class com.onfido.models.Report
toString() - Method in class com.onfido.models.SdkToken.Request
toString() - Method in class com.onfido.models.SdkToken
toString() - Method in class com.onfido.models.Webhook.Request
toString() - Method in class com.onfido.models.Webhook
town(String) - Method in class com.onfido.models.Address.Request: The town of the applicant’s address
type(String) - Method in class com.onfido.models.Document.Request: The type of document
type(String) - Method in class com.onfido.models.IdNumber.Request: Type of ID number.

U

unknownApiUrl(String) - Method in class com.onfido.Onfido.Builder: Sets the object to use the specified URL for the api.
update(String, Applicant.Request) - Method in class com.onfido.ApplicantManager: Updates an applicant’s information.
update(String, Webhook.Request) - Method in class com.onfido.WebhookManager: Edits a webhook.
upload(InputStream, String, Document.Request) - Method in class com.onfido.DocumentManager: Uploads a document as part of a multipart request.
upload(InputStream, String, LivePhoto.Request) - Method in class com.onfido.LivePhotoManager: Uploads a live photo as part of a multipart request.
uploadRequest(String, RequestBody) - Method in class com.onfido.api.ResourceManager: Makes a POST http call to the specified path and multipart request body.
url(String) - Method in class com.onfido.models.Webhook.Request: The url to listen to notifications (must be HTTPS)
usDrivingLicence(DrivingLicence.Request) - Method in class com.onfido.models.Check.Request: An object that contains all accepted fields for the Driver's License Data Verification report.

V

validateImageQuality(Boolean) - Method in class com.onfido.models.Document.Request: When true the submitted image will undergo an image quality validation
value(String) - Method in class com.onfido.models.IdNumber.Request: Value of ID number

W

webhook - Variable in class com.onfido.Onfido: The manager class for the Webhook resource.
Webhook - Class in com.onfido.models
Webhook.Request - Class in com.onfido.models
WebhookEvent - Class in com.onfido.webhooks: The response from Webhook events.
WebhookEvent(String, String, WebhookEventObject) - Constructor for class com.onfido.webhooks.WebhookEvent: Instantiates a new WebhookEvent.
WebhookEventObject - Class in com.onfido.webhooks: The event object within the webhook event response.
WebhookEventObject(String, String, String, String) - Constructor for class com.onfido.webhooks.WebhookEventObject: Instantiates a new Webhook event object.
WebhookEventVerifier - Class in com.onfido.webhooks: Contains a public method for verifying webhook responses.
WebhookEventVerifier(String) - Constructor for class com.onfido.webhooks.WebhookEventVerifier: Instantiates a new WebhookEventVerifier.
webhookIds(String...) - Method in class com.onfido.models.Check.Request: Array of strings describing which webhooks to trigger for a check.
webhookIds(List<String>) - Method in class com.onfido.models.Check.Request: Array of strings describing which webhooks to trigger for a check.
WebhookManager - Class in com.onfido: Manager class for the Webhook resource type.
WebhookManager(Config, OkHttpClient) - Constructor for class com.onfido.WebhookManager
WebhookPayload - Class in com.onfido.webhooks: A wrapper class for parsing webhook event responses.
WebhookPayload(WebhookEvent) - Constructor for class com.onfido.webhooks.WebhookPayload: Instantiates a new Webhook payload.
weightMeasure(Integer) - Method in class com.onfido.models.DrivingLicence.Request: Weight in pounds

A B C D E F G H I L M N O P R S T U V W
All Classes All Packages