IDentitySDK
public class IDentitySDK
Documentation for the IDentitySDK.framework methods and parameter overrides.
-
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
languageUser Interface Language. Default is
en(English).isGPSEnabledset true / false to enable disbale location
isUpdateModelsDataWhether or not to download the latest SDK models after credential verification. Default is
true.accessTokenaccessToken generated at user
completionIf
Error?isnil, the SDK was initialized successfully.
-
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
presenterUIViewControllerto present the flow from.nameAdditional document name.
uploadDocumentAdditional document.
processAsPOAprocessAsPOA description
completionReturns a
AdditionalDocumentsRequestto send to the server. -
RESTful API base URL. Default is:
https://api.idmission.com/Declaration
Swift
static var apiBaseUrl: String { get set }
-
Declaration
Swift
class func getXMLString(request: GenericDataRequest, genericDataDictionary: [String : Any]) -> String
-
Declaration
Swift
class func getJSONString(dictionary: [String : Any]) -> String?
-
Declaration
Swift
class func getImageJSONString(for fileBase64: String, formKey: String, ifForFace: Bool? = nil, pdfDocumentName: String? = nil, extensionType: ExtensionType? = nil) -> String? -
Declaration
Swift
class func getDigitalSignatureJSONString(fileContent: String) -> String? -
Declaration
Swift
class func getFingerprintJSONString(fingerPrintData: FingerPrintData?) -> String? -
Declaration
Swift
class func getVoiceJSONString(fileContent: String, formKey: String) -> String?
-
Declaration
Swift
class func getLiveFaceImageDataNode(formKey: String, formID: String, request: GenericDataRequest, additionalData: [String : Any]?) -> String? -
Declaration
Swift
class func getPrimaryIdImageDataNode(formKey: String, serviceId: String?, request: GenericDataRequest) -> String? -
Declaration
Swift
class func getSecodaryIdImageDataNode(formKey: String, request: GenericDataRequest) -> String? -
Declaration
Swift
class func getEmployeeInformationDataNode(request: GenericDataRequest, employeeInfoXMLString: String?, employeeCode: String?, serviceID: String?) -> String? -
Declaration
Swift
class func getSignatureCaptureNode(request: GenericDataRequest, isDigitalSignatureEnabled: Bool) -> String? -
Declaration
Swift
class func getFingerPrintXMLNode(request: GenericDataRequest, for process: String) -> String? -
getAdditionalDataXMLNode(loginId:merchantId: CompanyId: companyName: formKey: request: additionalDictionary: ) Declaration
Swift
class func getAdditionalDataXMLNode(loginId: String, merchantId: String, CompanyId: String, companyName: String, formKey: String, request: GenericDataRequest, additionalDictionary: [String : Any]?) -> String? -
Declaration
Swift
public static var fingerprintDetectionModelName: String { get } -
Declaration
Swift
public static var focusModelName: String { get } -
Declaration
Swift
public static var focusFaceModelName: String { get } -
Version of the SDK.
Declaration
Swift
public static var version: String { get } -
Plugin or platform name of the application.
Declaration
Swift
public static var pluginName: String -
Declaration
Swift
public static var requestID: String { get }
-
Capturing ID document(s), validate the ID and extract data from it.
-
Deprecated method & no longer will use in future release
-
Capturing ID document(s), validate the ID and extract data from it.
-
Deprecated method & no longer will use in future release
-
Capturing ID document(s), validate the ID and extract data from it.
Declaration
Swift
public class func idValidation(from presenter: UIViewController, customerDataOptions: CommonCustomerDataRequest? = nil, options: AdditionalCustomerWFlagCommonData, completion: @escaping ValidateIdCompletion)Parameters
presenterUIViewControllerto present the flow from.customerDataOptionsIts instance of CustomerValidateIdDataRequest
optionsService options.
completionReturns a
CustomerValidateIdRequestto send to the server. -
Deprecated method & no longer will use in future release
Declaration
Swift
public class func idValidation(from presenter: UIViewController, options: AdditionalCustomerWFlagCommonDataV3, completion: @escaping ValidateIdCompletion) -
Declaration
Swift
public class func autofill(from presenter: UIViewController, completion: @escaping AutofillCompletion)
-
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
presenterUIViewControllerto present the flow from.customerDataOptionsIts instance of CustomerValidateIdDataRequest
optionsAdditionalCustomerLiveCheckDataUsed to set Service options.completionReturns a
CustomerLiveCheckRequestto send to the server.
-
Customer Data sent is enrolled with customer record and not processed.
Declaration
Swift
public class func customerEnrollBiometrics(from presenter: UIViewController, customerDataOptions: CommonCustomerDataRequest? = nil, personalData: PersonalCustomerEnrollBiometricsRequestData, options: AdditionalCustomerEnrollBiometricRequestData, completion: @escaping CustomerEnrollBiometricsCompletion)Parameters
presenterUIViewControllerto present the flow from.customerDataOptionsIts instance of CustomerValidateIdDataRequest
personalDataPersonalCustomerEnrollBiometricsRequestDataused to identify the customer.optionsAdditionalCustomerEnrollBiometricRequestDataUsed to set Service options.completionReturns a
CustomerEnrollBiometricsRequestto send to the server. -
Deprecated method & no longer will use in future release
Declaration
Swift
public class func customerEnrollBiometrics(from presenter: UIViewController, personalData: PersonalCustomerCommonRequestDataV3, options: AdditionalCustomerEnrollBiometricRequestDataV3, completion: @escaping CustomerEnrollBiometricsCompletion)
-
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
presenterUIViewControllerto present the flow from.customerDataOptionsIts instance of CustomerValidateIdDataRequest
personalDataPersonalCustomerVerifyDataused to identify the customer.optionsAdditionalCustomerCommonDataUsed to set Service options.completionReturns a
CustomerVerifyRequestto send to the server.
-
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
presenterUIViewControllerto present the flow from.customerDataOptionsIts instance of CustomerValidateIdDataRequest
optionsAdditionalCustomerCommonDataUsed to set Service options.completionReturns a
CustomerIdentifyRequestto send to the server.
-
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.
-
Deprecated method & no longer will use in future release
-
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.
-
Deprecated method & no longer will use in future release
-
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, customerDataOptions: CommonCustomerDataRequest? = nil, options: AdditionalCustomerWFlagCommonData, completion: @escaping ValidateIdMatchFaceCompletion)Parameters
presenterUIViewControllerto present the flow from.customerDataOptionsIts instance of CustomerValidateIdDataRequest
optionsService options.
completionReturns a
CustomerLiveCheckRequestto send to the server. -
Deprecated method & no longer will use in future release
Declaration
Swift
public class func idValidationAndMatchFace(from presenter: UIViewController, options: AdditionalCustomerWFlagCommonDataV3, completion: @escaping ValidateIdMatchFaceCompletion)
-
idValidationAndCustomerEnroll(from:customerDataOptions: 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.
-
Deprecated method & no longer will use in future release
-
idValidationAndCustomerEnroll(from:customerDataOptions: 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.
-
Deprecated method & no longer will use in future release
-
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, customerDataOptions: CommonCustomerDataRequest? = nil, personalData: PersonalCustomerCommonRequestEnrollData, options: AdditionalCustomerWFlagCommonData, completion: @escaping ValidateIdCustomerEnrollCompletion)Parameters
presenterUIViewControllerto present the flow from.optionsService options.
completionReturns a
CustomerEnrollRequestto send to the server. -
Deprecated method & no longer will use in future release
Declaration
Swift
public class func idValidationAndCustomerEnroll(from presenter: UIViewController, personalData: PersonalCustomerCommonRequestEnrollDataV3, options: AdditionalCustomerWFlagCommonDataV3, completion: @escaping ValidateIdCustomerEnrollCompletion)
-
Declaration
Swift
public class func genericApiCall(genericDataDictionary: [String : Any], completion: @escaping GenericAPICompletion)
-
Captures an Signature.
Declaration
Swift
public class func signatureCapture(from presenter: UIViewController, completion: @escaping SignatureCaptureCompletion)Parameters
presenterUIViewControllerto present the flow from.completionReturns a
SignatureDataRequestto send to the server. -
Captures an FingerPrint.
Declaration
Swift
public class func fingerPrintCapture(from presenter: UIViewController, completion: @escaping FingerPrintCaptureCompletion)Parameters
presenterUIViewControllerto present the flow from.completionReturns a
SignatureDataRequestto send to the server.
-
Captures voice audio data.
Declaration
Swift
public class func voiceCapture(from presenter: UIViewController, completion: @escaping VoiceCaptureCompletion)Parameters
presenterUIViewControllerto present the flow from.completionReturns an audio file
URL.