SybrinIdentity

A base class that is the main entry point for the SDK consumer

Declaration

@objc final public class SybrinIdentity : NSObject {
    @objc public static let shared: SybrinIdentity
    @objc final public var configuration: SybrinIdentityConfiguration?
    
    public typealias doneLaunchingType = (Bool, String?) -> Void
    public typealias failureCallbackType = (String) -> Void
    public typealias cancelCallbackType = () -> Void
    public typealias documentSuccessCallbackType = (DocumentModel) -> Void
    public typealias greenBookSuccessCallbackType = (GreenBookModel) -> Void
    public typealias idCardSuccessCallbackType = (IDCardModel) -> Void
    public typealias passportSuccessCallbackType = (PassportModel) -> Void
    public typealias driversLicenseSuccessCallbackType = (DriversLicenseModel) -> Void
    
    @objc final public func changeLogLevel(to logLevel: LogLevel)
    
    @objc final public func scanDocument(
        on viewController: UIViewController, 
        for document: Document, 
        doneLaunching: SybrinIdentity.doneLaunchingType? = nil, 
        success: SybrinIdentity.documentSuccessCallbackType? = nil, 
        failure: SybrinIdentity.failureCallbackType? = nil, 
        cancel: SybrinIdentity.cancelCallbackType? = nil
    )
    @objc final public func scanDriversLicense(
        on viewController: UIViewController, 
        for country: Country, 
        doneLaunching: SybrinIdentity.doneLaunchingType? = nil, 
        success: SybrinIdentity.driversLicenseSuccessCallbackType? = nil, 
        failure: SybrinIdentity.failureCallbackType? = nil, 
        cancel: SybrinIdentity.cancelCallbackType? = nil
    )
    @objc final public func scanGreenBook(
        on viewController: UIViewController, 
        doneLaunching: SybrinIdentity.doneLaunchingType? = nil, 
        success: SybrinIdentity.greenBookSuccessCallbackType? = nil, 
        failure: SybrinIdentity.failureCallbackType? = nil, 
        cancel: SybrinIdentity.cancelCallbackType? = nil
    )
    @objc final public func scanIDCard(
        on viewController: UIViewController, 
        for country: Country, 
        doneLaunching: SybrinIdentity.doneLaunchingType? = nil, 
        success: SybrinIdentity.idCardSuccessCallbackType? = nil, 
        failure: SybrinIdentity.failureCallbackType? = nil, 
        cancel: SybrinIdentity.cancelCallbackType? = nil
    )
    @objc final public func scanPassport(
        on viewController: UIViewController, 
        for country: Country, 
        doneLaunching: SybrinIdentity.doneLaunchingType? = nil, 
        success: SybrinIdentity.passportSuccessCallbackType? = nil, 
        failure: SybrinIdentity.failureCallbackType? = nil, 
        cancel: SybrinIdentity.cancelCallbackType? = nil
    )
}

Only relevant details are shown, boilerplate or standard Swift generated code is omitted

Summary

Public variables

Name	Type	Description
configuration	SybrinIdentityConfiguration?	Contains the configuration that you have set.

Public methods

Signature	Return Type	Description
changeLogLevel(to logLevel: LogLevel)	Void	Attempts to change the log level to the specified level. Some levels are restricted and can only be set by Sybrin developers.
scanDocument	Void	Opens the Sybrin view controller and starts the scan document feature. Read more at Document.
scanDriversLicense	Void	Opens the Sybrin view controller and starts the scan drivers license feature. Read more at Drivers License.
scanGreenBook	Void	Opens the Sybrin view controller and starts the scan green book feature. Read more at Green Book.
scanIDCard	Void	Opens the Sybrin view controller and starts the scan ID card feature. Read more at ID Card.
scanPassport	Void	Opens the Sybrin view controller and starts the scan passport feature. Read more at Passport.

Public variables

configuration

@objc final public var configuration: SybrinIdentityConfiguration?

It is required that you set this variable before attempting to use any of the Sybrin features. Learn how to Get Started

Contains the configuration that you have set.

Public methods

changeLogLevel(to logLevel: LogLevel)

@objc final public func changeLogLevel(to logLevel: LogLevel)

Attempts to change the log level to the specified level. Some levels are restricted and can only be set by Sybrin developers.

scanDocument

@objc final public func scanDocument( on viewController: UIViewController, for document: Document, doneLaunching: SybrinIdentity.doneLaunchingType? = nil, success: SybrinIdentity.documentSuccessCallbackType? = nil, failure: SybrinIdentity.failureCallbackType? = nil, cancel: SybrinIdentity.cancelCallbackType? = nil )

Opens the Sybrin view controller and starts the scan document feature. Read more at Document.

scanDriversLicense

@objc final public func scanDriversLicense( on viewController: UIViewController, for country: Country, doneLaunching: SybrinIdentity.doneLaunchingType? = nil, success: SybrinIdentity.driversLicenseSuccessCallbackType? = nil, failure: SybrinIdentity.failureCallbackType? = nil, cancel: SybrinIdentity.cancelCallbackType? = nil )

Opens the Sybrin view controller and starts the scan drivers license feature. Read more at Drivers License.

scanGreenBook

@objc final public func scanGreenBook( on viewController: UIViewController, doneLaunching: SybrinIdentity.doneLaunchingType? = nil, success: SybrinIdentity.greenBookSuccessCallbackType? = nil, failure: SybrinIdentity.failureCallbackType? = nil, cancel: SybrinIdentity.cancelCallbackType? = nil )

Opens the Sybrin view controller and starts the scan green book feature. Read more at Green Book.

scanIDCard

@objc final public func scanIDCard( on viewController: UIViewController, for country: Country, doneLaunching: SybrinIdentity.doneLaunchingType? = nil, success: SybrinIdentity.idCardSuccessCallbackType? = nil, failure: SybrinIdentity.failureCallbackType? = nil, cancel: SybrinIdentity.cancelCallbackType? = nil )

Opens the Sybrin view controller and starts the scan ID card feature. Read more at ID Card.

scanPassport

@objc final public func scanPassport( on viewController: UIViewController, for country: Country, doneLaunching: SybrinIdentity.doneLaunchingType? = nil, success: SybrinIdentity.passportSuccessCallbackType? = nil, failure: SybrinIdentity.failureCallbackType? = nil, cancel: SybrinIdentity.cancelCallbackType? = nil )

Opens the Sybrin view controller and starts the scan passport feature. Read more at Passport.

See also

• Country

• Document

• DocumentModel

• DriversLicenseModel

• GreenBookModel

• IDCardModel

• LogLevel

• PassportModel

• SybrinIdentityConfiguration