api
library
Classes
BaseResult
Base result for VIZResult and NFCResult.
CANNFCAccessKey
Card Access Number (CAN)
CaptureResult
Result with data from a captured identity document page.
CaptureResultFeature
A document feature
CaptureResultQualityCriterion
CategoryInfo
Information about a driving license category.
ConsolidatedIdentityData
Data from multiple sources, combined so that for each field data from the most reliable source available is used.
ConsolidatedValue <T >
A value that can consolidate data from multiple sources, where the content of this object contains the data from the most reliable source presented.
DocumentContent
Interpretation of the data read from a Machine Readable Travel Document.
DocumentInfo
Basic information about the scanned document.
EDLDocumentContent
Interpretation of the data read from an Electronic Drivers License.
EDLNFCAccessKey
An NFC access key with the necessary credentials to access an NFC chip of an electronic driving licence (EDL).
ErrorResponse
Error response with code, message and an array of ErrorResponseError if available.
ErrorResponseError
Error response with reason and message.
Failure
Failure information.
Feature
A document feature
Features
Document features
Flow
Base class with common properties for all flows
ICAODocumentContent
Interpretation of the data read from a ICAO 9303 compliant Machine Readable Travel Document.
ICAONFCAccessKey
An NFC access key with the necessary credentials to access an NFC chip of an ICAO compliant Travel Document (ICAO TD).
IProovResponse
Gets the iProov response.
IProovResult <T >
Result received after completing iProov orchestration.
MethodChannelReadID
An implementation of ReadidPlatform that uses method channels.
ModelSource
Source of a piece of data
NFCAccessKey
NFC access key used for reading the NFC chip
NFCFlow
Base class for NFC only flows
NFCOnlyFlow
This flow only performs the NFC reading steps.
NFCResult
The NFC result object with the collected chip information.
NFCWithAccessControlFlow
This flow captures the details required to access a document's NFC chip and reads the document.
NFCWithVIZBothSidesFlow
In this flow, an image of both sides of the document is captured, before the NFC chip is read.
NFCWithVIZFallbackFlow
This flow goes to fallback flow if the document's NFC chip cannot be read.
OnfidoCheck
In the Onfido API a check is a request to carry out one or more reports on an applicant.
OnfidoReport
In the Onfido API a report is a single verification request, such as a Document Report or Facial Similarity Photo report.
OnfidoResponse
Onfido response that contains status of check request, and report.
QRCodeResult
The result of decoding a QR code
QualityCriteria
The quality criteria used during capture
QualityCriterion
A quality criterion
ReadIDFlow
Base class for all the ReadID flows
ReadIDPlatform
ReadIDResult
Wraps the NFCResult and VIZResult outcome from ReadID flow
ReadIDSession
Encapsulated session where information from a single document is captured. It can contain data read through NFC as well as optically captured data.
RetrieveIProovVerifyTokenResponse
Token response received for iProov orchestration.
UIEdgeInsets
The inset distances for views
UIFont
An object that provides access to the font’s characteristics.
UIResources
UI resources is an API to be able to change colors, images, and fonts, as described in the developer guide, which have impact on UI, on runtime.
ValidateIProovVerifyTokenResponse
Response received after validating iProov token during iProov orchestration
VeriffResponse
Represents a subset of the result from the veriff decision.
VeriffVerification
Model containing the information about the verification done by veriff.
VerifyOnfidoResponse
The verify Onfido response with the state, the Onfido response or the error response.
VerifyVeriffResponse
The verify Veriff response with the state, the Veriff response or the error response.
VIZFlow
Base class for VIZ only flows
VIZImage
VIZ Image meta data.
VIZImages
Contains data optically captured from the Visual Inspection Zone (VIZ).
VIZNFCFlow
Base class with properties common to all VIZ + NFC flows
VIZOnlyBothSidesFlow
In this flow an image of both sides of the document is captured.
VIZOnlyOnePageFlow
This flow visually captures a single page of a document.
VIZQRCodeSession
This object represents QR Code data provided by the VIZ Capture component.
VIZResult
The MRZ result object with the collected MRZ information.
