VerIDRegistrationSessionSettings

@objc
public class VerIDRegistrationSessionSettings : VerIDSessionSettings

Settings for registration sessions

  • Bearings to register in the session. The default is [.straight]. For settings with liveness detection set to strict the default is [.straight, .left, .leftUp, .up, .rightUp, .right].

    Declaration

    Swift

    public var bearingsToRegister: [VerIDBearing]
  • Liveness detection level to be used at authentication. Default is [.regular].

    Declaration

    Swift

    @objc
    public var livenessDetection: VerIDLivenessDetection { get set }
  • ID of the user to register

    Declaration

    Swift

    @objc
    public let userId: String
  • False to delete the user before registering faces

    Declaration

    Swift

    @objc
    public var appendIfUserExists: Bool
  • Constructor

    Declaration

    Swift

    @available(*, deprecated: 3.2.0)
    @objc
    public init(userId: String? = nil, livenessDetection: VerIDLivenessDetection = .regular, showGuide: Bool = false, showResult: Bool = false)

    Parameters

    userId

    ID of the user to register, UUID will be generated if nil

    livenessDetection

    The level of liveness detection that will be available at authentication. The default is .regular

    showGuide

    True to show a guide to the user before the registration

    showResult

    True to show the result of the session to the user

  • Constructor

    Declaration

    Swift

    @available(* 3.2.0, *)
    @objc
    public init(userId: String? = nil, livenessDetection: VerIDLivenessDetection = .regular, showResult: Bool = false)

    Parameters

    userId

    ID of the user to register, UUID will be generated if nil

    livenessDetection

    The level of liveness detection that will be available at authentication. The default is .regular

    showResult

    True to show the result of the session to the user