Passport
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 country, check out Supported Documents! To request support for a country, contact us!
Calling the function
Parameters
Type | Description |
UIViewController | The controller you would like to present on. |
The country you would like to scan for. |
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:
Type | Description |
Bool |
|
String? | If an error occurs, a message describing the error; otherwise, |
Example:
success
The success
callback will be executed after scanning has finished and the view controller has been dismissed.
Parameters:
Type | Description |
An object containing the results of the scanned passport. |
As explained in Features, the success
callback will always return the country specific model but in its parent class form. 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 scanPassport
function with the .SouthAfrica
country parameter. The result will be of type SouthAfricaPassportModel, but is returned in its parent form PassportModel. To access all the data specific to SouthAfricaPassportModel you will need to cast the PassportModel to that type.
Example:
failure
The failure
callback will be executed after scanning has failed and the view controller has been dismissed.
Parameters:
Type | Description |
String? | A message describing the error. |
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
Example:
Full Example
Last updated