IDentitySDK Class Reference


                    
                    
                    initializeSDK(language:isGPSEnabled:isUpdateModelsData:accessToken:completion:)

Initializes the IDentitySDK framework.

Declaration

Swift

public class func initializeSDK(/*loginId: String,
                                password: String,
                                merchantId: String,*/
                                language: Language = .en,
                                isGPSEnabled: Bool = true,
                                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
`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


                    
                    
                    documentCapture(from:documentName:processAsPOA:uploadDocument:completion:)

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.

apiBaseUrl
RESTful API base URL. Default is: https://api.idmission.com/
Declaration
Swift

static var apiBaseUrl: String { get set }


                    
                    
                    fingerprintDetectionModelName

Declaration

Swift

public static var fingerprintDetectionModelName: String { get }


                    
                    
                    focusModelName

Declaration

Swift

public static var focusModelName: String { get }


                    
                    
                    focusFaceModelName

Declaration

Swift

public static var focusFaceModelName: String { get }


                    
                    
                    version

Version of the SDK.

Declaration

Swift

public static var version: String { get }

pluginName
Plugin or platform name of the application.
Declaration
Swift

public static var pluginName: String


                    
                    
                    requestID

Declaration

Swift

public static var requestID: String { get }

ID Validation (20)

idValidation(from:options:captureBack:completion:)

Capturing ID document(s), validate the ID and extract data from it.
idValidation(from:options:idType:idCountry:idState:completion:)

Capturing ID document(s), validate the ID and extract data from it.


                    
                    
                    idValidation(from:options:completion:)

Capturing ID document(s), validate the ID and extract data from it.

Declaration

Swift

public class func idValidation(from presenter: UIViewController, options: AdditionalCustomerWFlagCommonData, completion: @escaping ValidateIdCompletion)

Parameters

`presenter`	`UIViewController` to present the flow from.
`options`	Service options.
`completion`	Returns a `CustomerValidateIdRequest` to send to the server.


                    
                    
                    idValidation(from:options:completion:)

Deprecated method & no longer will use in future release

Declaration

Swift

public class func idValidation(from presenter: UIViewController, options: AdditionalCustomerWFlagCommonDataV3, completion: @escaping ValidateIdCompletion)


                    
                    
                    autofill(from:completion:)

Declaration

Swift

public class func autofill(from presenter: UIViewController, completion: @escaping AutofillCompletion)

Live Face Check (660)


                    
                    
                    liveFaceCheck(from:completion:)

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, completion: @escaping LiveFaceCheckCompletion)

Parameters

`presenter`	`UIViewController` to present the flow from.
`completion`	Returns a `CustomerLiveCheckRequest` to send to the server.

Enroll Biometric (175)


                    
                    
                    customerEnrollBiometrics(from:personalData:options:completion:)

Customer Data sent is enrolled with customer record and not processed.

Declaration

Swift

public class func customerEnrollBiometrics(from presenter: UIViewController, personalData: PersonalCustomerEnrollBiometricsRequestData, options: AdditionalCustomerEnrollBiometricRequestData, completion: @escaping CustomerEnrollBiometricsCompletion)

Parameters

`presenter`	`UIViewController` to present the flow from.
`personalData`	`PersonalCustomerEnrollBiometricsRequestData` used to identify the customer.
`options`	Service options.
`completion`	Returns a `CustomerEnrollBiometricsRequest` to send to the server.


                    
                    
                    customerEnrollBiometrics(from:personalData:options:completion:)

Customer Data sent is enrolled with customer record and not processed.

Declaration

Swift

public class func customerEnrollBiometrics(from presenter: UIViewController, personalData: PersonalCustomerCommonRequestDataV3, options: AdditionalCustomerEnrollBiometricRequestDataV3, completion: @escaping CustomerEnrollBiometricsCompletion)

Parameters

`presenter`	`UIViewController` to present the flow from.
`personalData`	`PersonalCustomerCommonRequestDataV3` used to identify the customer.
`options`	Service options.
`completion`	Returns a `CustomerEnrollBiometricsRequest` to send to the server.

Customer Verification (105)


                    
                    
                    customerVerification(from:personalData:completion:)

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

Declaration

Swift

public class func customerVerification(from presenter: UIViewController, personalData: PersonalCustomerVerifyData, completion: @escaping CustomerVerificationCompletion)

Parameters

`presenter`	`UIViewController` to present the flow from.
`personalData`	`PersonalCustomerVerifyData` used to identify the customer.
`completion`	Returns a `CustomerVerifyRequest` to send to the server.

Customer Biometric Verification (185)


                    
                    
                    identifyCustomer(from:completion:)

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, completion: @escaping CustomerIdentifyCompletion)

Parameters

`presenter`	`UIViewController` to present the flow from.
`completion`	Returns a `CustomerIdentifyRequest` to send to the server.

ID Validation and Face Match (10)

idValidationAndMatchFace(from:options:captureBack:completion:)

Capturing ID document(s), validate the ID and extract data from it. Additionally capture a selfie and match it against the photo on the ID.
idValidationAndMatchFace(from:options:idType:idCountry:idState:completion:)

Capturing ID document(s), validate the ID and extract data from it. Additionally capture a selfie and match it against the photo on the ID.


                    
                    
                    idValidationAndMatchFace(from:options:completion:)

Capturing ID document(s), validate the ID and extract data from it. Additionally capture a selfie and match it against the photo on the ID.

Declaration

Swift

public class func idValidationAndMatchFace(from presenter: UIViewController,
                                           options: AdditionalCustomerWFlagCommonData,
                                           completion: @escaping ValidateIdMatchFaceCompletion)

Parameters

`presenter`	`UIViewController` to present the flow from.
`options`	Service options.
`completion`	Returns a `CustomerLiveCheckRequest` to send to the server.


                    
                    
                    idValidationAndMatchFace(from:options:completion:)

Capturing ID document(s), validate the ID and extract data from it. Additionally capture a selfie and match it against the photo on the ID.

Declaration

Swift

public class func idValidationAndMatchFace(from presenter: UIViewController,
                                           options: AdditionalCustomerWFlagCommonDataV3,
                                           completion: @escaping ValidateIdMatchFaceCompletion)

Parameters

`presenter`	`UIViewController` to present the flow from.
`options`	Service options.
`completion`	Returns a `CustomerLiveCheckRequest` to send to the server.

Enroll Customer with ID Validation (50)

idValidationAndCustomerEnroll(from:personalData:options:captureBack:completion:)

Capturing ID document(s), validate that ID and extract data from it. Additionally capture a selfie of the customer and match it against the photo on the ID, then enroll all captured biometrics with the customer if the match is positive.
idValidationAndCustomerEnroll(from:personalData:options:idType:idCountry:idState:completion:)

Capturing ID document(s), validate that ID and extract data from it. Additionally capture a selfie of the customer and match it against the photo on the ID, then enroll all captured biometrics with the customer if the match is positive.


                    
                    
                    idValidationAndCustomerEnroll(from:personalData:options:completion:)

Capturing ID document(s), validate that ID and extract data from it. Additionally capture a selfie of the customer and match it against the photo on the ID, then enroll all captured biometrics with the customer if the match is positive.

Declaration

Swift

public class func idValidationAndCustomerEnroll(from presenter: UIViewController, personalData: PersonalCustomerCommonRequestEnrollData, options: AdditionalCustomerWFlagCommonData, completion: @escaping ValidateIdCustomerEnrollCompletion)

Parameters

`presenter`	`UIViewController` to present the flow from.
`options`	Service options.
`completion`	Returns a `CustomerEnrollRequest` to send to the server.


                    
                    
                    idValidationAndCustomerEnroll(from:personalData:options:completion:)

Capturing ID document(s), validate that ID and extract data from it. Additionally capture a selfie of the customer and match it against the photo on the ID, then enroll all captured biometrics with the customer if the match is positive.

Declaration

Swift

public class func idValidationAndCustomerEnroll(from presenter: UIViewController, personalData: PersonalCustomerCommonRequestEnrollDataV3, options: AdditionalCustomerWFlagCommonDataV3, completion: @escaping ValidateIdCustomerEnrollCompletion)

Parameters

`presenter`	`UIViewController` to present the flow from.
`options`	Service options.
`completion`	Returns a `CustomerEnrollRequest` to send to the server.

Document Capture


                    
                    
                    signatureCapture(from:completion:)

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.


                    
                    
                    fingerPrintCapture(from:completion:)

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.

Video ID


                    
                    
                    videoIDCapture(from:front:back:text:completion:)

Validates captured ID results with a live user.

Declaration

Swift

public class func videoIDCapture(from presenter: UIViewController, front: DetectedData, back: DetectedData? = nil, text: String, completion: @escaping VideoIdCompletion)

Parameters

`presenter`	`UIViewController` to present the flow from.
`front`	`front` detected data from a previous ID Validation `ValidateIdResult`.
`back`	`back` detected data from a previous ID Validation `ValidateIdResult`.
`text`	Text for the user to read aloud during video recording.
`completion`	Returns a `VideoIdResult` video capture result.

Voice Capture


                    
                    
                    voiceCapture(from:completion:)

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`.