Document
Declaration
To view all the type aliases, go to the SybrinIdentity class
Handling the doneLaunching
, success
, failure
or cancel
callbacks are optional but recommended.
To find out if we support a document, check out Supported Documents! To request support for a document, contact us!
Calling the function
Parameters
Handling callback responses
doneLaunching
The doneLaunching
callback will be executed after the view controller has successfully launched, or if the view controller failed to launch.
Parameters:
Example:
success
The success
callback will be executed after scanning has finished and the view controller has been dismissed.
Parameters:
As explained in Features, the success
callback will always return the country specific model but in its parent class form (DocumentModel). However, this can be casted to the country specific model to access that country model's specific properties.
This is not required, but is recommended if you would like to access the country model's specific properties.
Let's say that you provide the scanDocument
function with the .SouthAfricaIDCard
parameter. The result will be of type SouthAfricaIDCardModel, but is returned in its parent form DocumentModel. To access all the data specific to SouthAfricaIDCardModel you will need to cast the DocumentModel to that type.
Example:
failure
The failure
callback will be executed after scanning has failed and the view controller has been dismissed.
Parameters:
If you would like to report a bug, contact us!
Example:
cancel
The cancel
callback will be executed after the user has dismissed the view controller and before scanning could finish.
Parameters:
None