{"id":30366961,"url":"https://github.com/regulaforensics/idv-ios","last_synced_at":"2026-02-19T11:11:58.675Z","repository":{"id":287036856,"uuid":"962630417","full_name":"regulaforensics/IDV-iOS","owner":"regulaforensics","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-26T10:16:49.000Z","size":17,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-26T11:32:26.414Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/regulaforensics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-04-08T12:48:58.000Z","updated_at":"2025-06-26T10:16:49.000Z","dependencies_parsed_at":"2025-04-09T17:24:38.955Z","dependency_job_id":"5c4df417-6e66-4fd9-854d-69a52d0a7368","html_url":"https://github.com/regulaforensics/IDV-iOS","commit_stats":null,"previous_names":["regulaforensics/idv-ios"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/regulaforensics/IDV-iOS","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FIDV-iOS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FIDV-iOS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FIDV-iOS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FIDV-iOS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regulaforensics","download_url":"https://codeload.github.com/regulaforensics/IDV-iOS/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FIDV-iOS/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271236280,"owners_count":24723978,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-19T23:11:00.365Z","updated_at":"2026-02-19T11:11:53.642Z","avatar_url":"https://github.com/regulaforensics.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# **IDV SDK Integration Guide**\n\n## **Introduction**\n\nThis guide provides step-by-step instructions on integrating the **IDV SDK** into an iOS application. \nIt covers initialization, API configuration, workflow setup, and starting the ID verification process.\n\n\n## **1. Prerequisites**\n\nBefore integrating the SDK, ensure the following:\n- Xcode version is 16.0 and above.\n- The application Minimum Deployment Target is **iOS 13.0** and above.\n- The `Near Field Communication Tag Reading` capability is enabled the application target.\n\n\n## **2. IDV dependencies setup** \n1. Add `IDVSDK` dependency to `Podfile`.\n2. Add `IDVDocumentReader` dependency. The dependency is optional. \n2.1 Add `IDVDocumentReader` dependency to `Podfile`. \n2.2. Add the DocumentReader Core (e.g: `DocumentReaderFullAuthRFID`) according youre requirements.\n2.3. Add **regula.license** file to the application target. Setting is for `IDVDocumentReader` dependency.\n2.4. Add **db.dat** file to the application target to use local database.\n3. Add `IDVFaceSDK` dependency. The dependency is optional.\n3.1. Add `IDVFaceSDK` dependency to `Podfile`.\n3.2. Add the FaceSDK Core dependency `FaceCoreBasic`.\n4. Run `pod install`.\n\n\n## **3. Info.plist file setup**\n1. Set the description for **NSCameraUsageDescription** setting.\n2. Set **NFC** settings:\n```xml\n\u003ckey\u003ecom.apple.developer.nfc.readersession.felica.systemcodes\u003c/key\u003e\n    \u003carray\u003e\n        \u003cstring\u003e12FC\u003c/string\u003e\n    \u003c/array\u003e\n    \u003ckey\u003ecom.apple.developer.nfc.readersession.iso7816.select-identifiers\u003c/key\u003e\n    \u003carray\u003e\n        \u003cstring\u003eA0000002471001\u003c/string\u003e\n        \u003cstring\u003eE80704007F00070302\u003c/string\u003e\n        \u003cstring\u003eA000000167455349474E\u003c/string\u003e\n        \u003cstring\u003eA0000002480100\u003c/string\u003e\n        \u003cstring\u003eA0000002480200\u003c/string\u003e\n        \u003cstring\u003eA0000002480300\u003c/string\u003e\n        \u003cstring\u003eA00000045645444C2D3031\u003c/string\u003e\n    \u003c/array\u003e\n```\n\n\n## **4. Initialize Regula IDV SDK**\n\nIn your swift code import the framework and initialize the SDK :\n\n```swift\nimport IDVSDK\n\nIDV.shared.initialize { result in\n  // handle initialize results\n}\n```\n\n\n## **5. Configure API Settings**\n\nBefore using the SDK, configure the API connection:\n\n```swift\nlet userName = \"your_username\"\nlet password = \"your_password\"\nlet hostURL = \"https://your_host_url.com\"\nlet connectinConfig = IDVConnectionConfig(userName: userName,\n                                          password: password,\n                                          url: hostURL)\nIDV.shared.configure(with: connectinConfig) { result in\n  // handle connection results\n}\n```\n\n\n## **6. Prepare and Start an ID Verification Workflow**\n\n```swift\nlet workflowId = \"your_workflow_id\"\nlet workflowConfig = WorkflowConfig(workflowId: workflowId)\nIDV.shared.prepareWorkflow(by: workflowConfig) { results in\n    // handle prepare workflow results\n}\n```\n\nStart the workflow when ready:\n\n```swift\nIDV.shared.startWorkflow(presenter: presenterViewController) { result in\n    switch result {\n    case .success:\n        // handle success\n    case .failure(let error):\n        //handle error\n    }\n}\n```\n\nTo start workflow with metadata dictionary: \n\n```swift\nvar config = StartWorkflowConfig.default()\nconfig.metadata = [\"key\": \"value\"]\nIDV.shared.startWorkflow(presenter: self, config: config) { result in\n  switch result {\n  case .success:\n    // handle success\n  case .failure(let error):\n    //handle error\n  }\n}\n```\n\nTo start workflow with locale language: \n\n```swift\nvar config = StartWorkflowConfig.default()\nconfig.locale = \"en\"\nIDV.shared.startWorkflow(presenter: self, config: config) { result in\n  switch result {\n  case .success:\n    // handle success\n  case .failure(let error):\n    //handle error\n  }\n}\n```\n\n## **7. Best Practices \u0026 Troubleshooting**\n\n- **Grant camera permissions** before starting the workflow.\n- **Use proper credentials** when configuring `IDVConnectionConfig`.\n\n---\n\n## **Conclusion**\n\nThis guide provides all necessary steps to integrate the **Regula IDV SDK** into an iOS application. By following these instructions, developers can build a document verification feature using Regula’s technology.\n\nFor further details, refer to the **official Regula IDV SDK documentation** or contact their support team.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fidv-ios","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregulaforensics%2Fidv-ios","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fidv-ios/lists"}