{"id":19943496,"url":"https://github.com/iproov/ios-api-client","last_synced_at":"2026-01-23T05:38:15.466Z","repository":{"id":127780823,"uuid":"189988775","full_name":"iProov/ios-api-client","owner":"iProov","description":"iOS Swift API Client for iProov's REST API v2","archived":false,"fork":false,"pushed_at":"2025-01-08T11:32:42.000Z","size":337,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-11-22T12:19:53.367Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iProov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-06-03T11:01:46.000Z","updated_at":"2025-04-18T00:51:21.000Z","dependencies_parsed_at":"2025-09-19T11:32:00.237Z","dependency_job_id":"a06f8c5e-e37d-470c-9b84-a0545082e9cd","html_url":"https://github.com/iProov/ios-api-client","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/iProov/ios-api-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iProov%2Fios-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iProov%2Fios-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iProov%2Fios-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iProov%2Fios-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iProov","download_url":"https://codeload.github.com/iProov/ios-api-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iProov%2Fios-api-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28681024,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T04:33:33.518Z","status":"ssl_error","status_checked_at":"2026-01-23T04:33:30.433Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2024-11-13T00:17:01.911Z","updated_at":"2026-01-23T05:38:15.459Z","avatar_url":"https://github.com/iProov.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# iProov iOS API Client\n\n## Introduction\n\nThe iProov iOS API Client is a simple wrapper for the [iProov REST API v2](https://secure.iproov.me/docs.html) written in Swift and using [Alamofire](https://github.com/Alamofire/Alamofire). We also have an Android API client available [here](https://github.com/iProov/android-api-client).\n\n## Important security notice\n\nIn production, the iProov REST API should only ever be called directly from your back-end, however this library is designed to help you with debugging/evaluating the [iProov iOS SDK](https://github.com/iProov/ios), to get up-and-running quickly with a pure on-device demo.\n\nUse of the iOS API Client requires providing it with your API secret. **You should never embed your API secret within a production app**. \n\n...Although, if by any chance you happen to use Swift on your [back](https://vapor.codes/)-[end](https://perfect.org/) then you can probably use this code on your server, with just a few modifications (for example, you will need to handle images without UIKit).\n\n## Installation\n\n### Swift Package Manager\n\nWe recommend the iOS API Client is installed as a Swift Package:\n\n1. Select `File` → `Add Package Dependencies…` in the Xcode menu bar.\n\n2. Search for the iOS API Client package using the following URL:\n\n\t```\n\thttps://github.com/iProov/ios-api-client\n\t```\n\t\n3. Set the _Dependency Rule_ to be _Up to Next Major Version_.\n\t\n4. Click _Add Package_ to add the iOS API Client dependency to your Xcode project and to your app target, and then click again to confirm.\n\n### Cocoapods\n\nThe iOS API Client can also be installed as a Cocoapods dependency. Simply add the following line to your Podfile:\n\n```\npod 'iProovAPIClient'\n```\n\nAnd then run `pod install`.\n\n## Supported functionality\n\n- `getToken()` - Get an enrol/verify token.\n- `enrolPhoto()` - Once you have an enrolment token, you can enrol a photo against it.\n- `validate()` - Validates an existing token.\n- `enrolPhotoAndGetVerifyToken()` - A helper function which chains together `getToken()` for the enrolment token, `enrolPhoto()` to enrol the photo, and then `getToken()` for the verify token, which you can then use to launch the SDK.\n\n## Example\n\nExample of using iProov API Client together with iProov to get a verify token for an existing user and then launch the iProov SDK to perform the verification using Genuine Presence Assurance:\n\n```swift\nimport iProovAPIClient\nimport iProov\n\nlet apiClient = APIClient(baseURL: \"https://eu.rp.secure.iproov.me\",\n                          apiKey: \"{{ Your API key }}\",\n                          secret: \"{{ Your API secret }}\")\n\napiClient.getToken(assuranceType: .genuinePresence,\n                   type: .verify,\n                   userID: \"user@example.com\") { result in\n\n    switch result {\n    case let .success(token):\n\n        IProov.launch(streamingURL: \"https://eu.rp.secure.iproov.me\",\n                      token: token) { status in\n            print(status)\n        }\n\n    case let .failure(error):\n        print(error)\n    }\n}\n```\n\n## License\n\nThe iProov iOS API Client is licensed under the BSD-3 license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiproov%2Fios-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiproov%2Fios-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiproov%2Fios-api-client/lists"}