Document
Configuration
To use any Sybrin SDK you will need a Sybrin issued license. You can have a look at our licensing page to request one.
Using the license provided you will need to build and instance of the SybrinIdentityConfiguration class that will help with configuring the SDKs' behavior.
For example:
To see the full range of configuration available please visit the SybrinIdentityConfiguration page
Calling feature
To start scanning a document you will need to get an instance of the SybrinIdentity class using the configuration built before. With this object you will be able to call the scanDocument
method, which has a Document as a parameter. Finally you can register for the 3 different callbacks right on the method call.
For example:
Subscribing to any of the callbacks on the scanDocument
method is optional.
Setting a Cutout for Generic Document
A custom cutout can be specified for Generic Document before scanning is started. The specific cutout overlay to use for Generic Document can be specified programmatically as follows.
For example:
The cutout type specified for the example is the ID_CARD cutout but any of the cutout
types in CutoutType can be specified here.
Handling callback responses
There are 3 different callbacks that can be subscribed to. They are as follows:
OnSuccessListener
When the SDK has completed the scanning process the result of that process will be posted to the OnSuccessListener.onSuccess
callback. The DocumentModel that is returned is a parent class to all country specific classes.
Lets say that you provide the scanDocument
method with the Document.SouthAfricaIDCard
parameter. The result that will be posted to the OnSuccessListener
will be of type SouthAfricaIDCardModel, but is returned in its parent form. To access all the data specific to the SouthAfricaIDCardModel you will need to cast the DocumentModel to that type. Luckily, we have made this easy with the castToModel
method.
For example:
OnFailureListener
When the SDK encounters an error an IdentityException is posted to the OnFailureListener.onFailure
callback. The IdentityException will contain all the needed information to help solve the issue causing the error.
For example:
If you would like to report a bug, contact us!
OnCancelListener
When the scanning process is interrupted by the user by pressing the back button the SDK will post a response to the OnCancelListener.onCancel
callback. This callback has no return value.
For example:
Full example
Last updated