Mobile SDKs18 pages

IDentitySDK Class Reference

← Browse native SDK reference

On this page · 69 sections

IDentitySDK

public class IDentitySDK

Documentation for the IDentitySDK.framework methods and parameter overrides.

  • List of known client-side framework names that should be allowed to load Add the names (e.g., “FridaDetector”) before calling initializeSDK.

    Declaration

    Swift

    public static var allowedSecurityFrameworks: [String]
  • Declaration

    Swift

    public class func setDevelopmentRelaxationSecret(_ secret: Int)
  • Declaration

    Swift

    public class func setScreenSecurityEnabled(_ enabled: Bool)
  • Declaration

    Swift

    public class func isScreenRecordingEnabled(_ enabled: Bool)
  • Declaration

    Swift

    public static var isInitialized: Bool { get }
  • Initializes the IDentitySDK framework.

    Declaration

    Swift

    public class func initializeSDK(language: Language = .en,
                                    isGPSEnabled: Bool = true,
                                    geolocationRequired: Bool = false,
                                    isUpdateModelsData: Bool = true,
                                    accessToken: String,
                                    completion: @escaping ErrorCompletion)

    Parameters

    language

    User Interface Language. Default is en (English).

    isGPSEnabled

    set true / false to enable disbale location

    geolocationRequired

    Whether or not geolocation permission is required. Default is false.

    isUpdateModelsData

    Whether or not to download the latest SDK models after credential verification. Default is true.

    accessToken

    accessToken generated at user

    completion

    If Error? is nil, the SDK was initialized successfully.

Document Capture

  • Captures an additional document.

    Declaration

    Swift

    public class func documentCapture(from presenter: UIViewController, documentName name: String, processAsPOA: ProcessAsPOA?, uploadDocument: Bool = false, completion: @escaping DocumentCaptureCompletion)

    Parameters

    presenter

    UIViewController to present the flow from.

    name

    Additional document name.

    uploadDocument

    Additional document.

    processAsPOA

    processAsPOA description

    completion

    Returns a AdditionalDocumentsRequest to send to the server.

  • RESTful API base URL. Default is: https://api.idmission.com/

    Declaration

    Swift

    static var apiBaseUrl: String { get set }

XML Request

Helper Method

Get JSON String

Get XML Tags

ID Validation (20)

Live Face Check (660)

  • Live Face Detection features the ability to perform of a liveness check of the photo image that is sent via API.

    Declaration

    Swift

    public class func liveFaceCheck(from presenter: UIViewController,
                                    customerDataOptions: CommonCustomerDataRequest? = nil,
                                    options: AdditionalCustomerLiveCheckData? = nil,
                                    completion: @escaping LiveFaceCheckCompletion)

    Parameters

    presenter

    UIViewController to present the flow from.

    customerDataOptions

    Its instance of CustomerValidateIdDataRequest

    options

    AdditionalCustomerLiveCheckData Used to set Service options.

    completion

    Returns a CustomerLiveCheckRequest to send to the server.

Enroll Biometric (175)

Customer Verification (105)

  • Capture of biometric data to verify against a previously enrolled customer.

    Declaration

    Swift

    public class func customerVerification(from presenter: UIViewController,
                                           customerDataOptions: CommonCustomerDataRequest? = nil,
                                           personalData: PersonalCustomerVerifyData,
                                           options: AdditionalCustomerCommonData,
                                           completion: @escaping CustomerVerificationCompletion)

    Parameters

    presenter

    UIViewController to present the flow from.

    customerDataOptions

    Its instance of CustomerValidateIdDataRequest

    personalData

    PersonalCustomerVerifyData used to identify the customer.

    options

    AdditionalCustomerCommonData Used to set Service options.

    completion

    Returns a CustomerVerifyRequest to send to the server.

Customer Biometric Verification (185)

  • Capture biometric data for a Customer (face, fingerprint, voice or iris) and search the customer DB to see if its already enrolled.

    Declaration

    Swift

    public class func identifyCustomer(from presenter: UIViewController,
                                       customerDataOptions: CommonCustomerDataRequest? = nil,
                                       options: AdditionalCustomerCommonData,
                                       completion: @escaping CustomerIdentifyCompletion)

    Parameters

    presenter

    UIViewController to present the flow from.

    customerDataOptions

    Its instance of CustomerValidateIdDataRequest

    options

    AdditionalCustomerCommonData Used to set Service options.

    completion

    Returns a CustomerIdentifyRequest to send to the server.

ID Validation and Face Match (10)

Enroll Customer with ID Validation (50)

SelfieCapture + IDCapture Methods

Document Capture

  • Captures an Signature.

    Declaration

    Swift

    public class func signatureCapture(from presenter: UIViewController, completion: @escaping SignatureCaptureCompletion)

    Parameters

    presenter

    UIViewController to present the flow from.

    completion

    Returns a SignatureDataRequest to send to the server.

  • Captures an FingerPrint.

    Declaration

    Swift

    public class func fingerPrintCapture(from presenter: UIViewController, completion: @escaping FingerPrintCaptureCompletion)

    Parameters

    presenter

    UIViewController to present the flow from.

    completion

    Returns a SignatureDataRequest to send to the server.

Voice Capture

  • Captures voice audio data.

    Declaration

    Swift

    public class func voiceCapture(from presenter: UIViewController, completion: @escaping VoiceCaptureCompletion)

    Parameters

    presenter

    UIViewController to present the flow from.

    completion

    Returns an audio file URL.

Report a docs issue

Copy this context into your team’s issue tracker or an email to support@idmission.com.