Identity Android
1.16
Search
K

SybrinIdentity

A base class that is the main entry point for the SDK consumer
import com.sybrin.identity.SybrinIdentity
To see this class and its functionality in action go visit our features page!

Summary

Static methods
Returns an already built instance of the SybrinIdentity class.
getInstance(Context context, SybrinIdentityConfiguration configuration)
Creates and returns an instance of the SybrinIdentity class.
Public methods
Starts the document scanning process.
Starts the driver's license scanning process.
Starts the green book scanning process.
scanIDCard(Country country)
Starts the ID card scanning process.
Starts the passport scanning process.

Static methods

getBuiltInstance

public static SybrinIdentity getBuiltInstance ()
Returns an already built instance of the SybrinIdentity class.
Returns
This value cannot be null.

getInstance

public static SybrinIdentity getInstance (Context context, SybrinIdentityConfiguration configuration)
Creates and returns an instance of the SybrinIdentity class using the provided configuration.
Parameters
context
Context
configuration
SybrinIdentityConfiguration: The built configuration needed by the SDK to manipulate behavior.
Returns
This value cannot be null.

Public methods

getConfiguration

public SybrinIdentityConfiguration getConfiguration ()
Returns the SybrinIdentityConfiguration provided when the SybrinIdentity instance was created.
Returns
This value cannot be null.

scanDocument

public IdentityScanner<DocumentModel> scanDocument (Document document)
Starts the document scanning process.
Parameters
document
Document: The selected document that the user wishes to scan.
Returns
This value cannot be null.

scanDriversLicense

public IdentityScanner<DriversLicenseModel> scanDriversLicense (Country country)
Starts the driver's license scanning process.
Parameters
country
Country: The country of the driver's license the user wishes to scan..
Returns
This value cannot be null.

scanGreenBook

public IdentityScanner<GreenBookModel> scanGreenBook ()
Starts the green book scanning process.
Returns
This value cannot be null.

scanIDCard

public IdentityScanner<IDCardModel> scanIDCard (Country country)
Starts the ID card scanning process.
Parameters
country
Country: The country of the ID card the user wishes to scan..
Returns
This value cannot be null.

scanPassport

public IdentityScanner<PassportModel> scanPassport (Country country)
Starts the passport scanning process.
Parameters
country
Country: The country of the passport the user wishes to scan..
Returns
This value cannot be null.