{"id":17300066,"url":"https://github.com/csantosm/capacitor-plugin-veriff","last_synced_at":"2025-07-31T07:33:03.181Z","repository":{"id":58010584,"uuid":"529635218","full_name":"CSantosM/capacitor-plugin-veriff","owner":"CSantosM","description":null,"archived":false,"fork":false,"pushed_at":"2023-08-15T19:55:07.000Z","size":838,"stargazers_count":2,"open_issues_count":1,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-08T12:14:45.684Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/CSantosM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2022-08-27T16:15:20.000Z","updated_at":"2024-12-24T03:15:13.000Z","dependencies_parsed_at":"2024-12-05T03:35:41.881Z","dependency_job_id":null,"html_url":"https://github.com/CSantosM/capacitor-plugin-veriff","commit_stats":{"total_commits":15,"total_committers":1,"mean_commits":15.0,"dds":0.0,"last_synced_commit":"9d46ecac4f35da4f03efe21de60fb264a0d3657d"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/CSantosM/capacitor-plugin-veriff","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSantosM%2Fcapacitor-plugin-veriff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSantosM%2Fcapacitor-plugin-veriff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSantosM%2Fcapacitor-plugin-veriff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSantosM%2Fcapacitor-plugin-veriff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CSantosM","download_url":"https://codeload.github.com/CSantosM/capacitor-plugin-veriff/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSantosM%2Fcapacitor-plugin-veriff/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268004257,"owners_count":24179381,"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-07-31T02:00:08.723Z","response_time":66,"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":"2024-10-15T11:25:29.963Z","updated_at":"2025-07-31T07:33:02.747Z","avatar_url":"https://github.com/CSantosM.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# capacitor-plugin-veriff\n\n[![npm version](https://img.shields.io/npm/v/capacitor-plugin-veriff)](https://www.npmjs.com/package/capacitor-plugin-veriff)\n\n\nCapacitor plugin exposing the [Veriff SDK](https://www.veriff.com/) - Smart and scalable identity verification\n\n\n## Integration\n\n### Android\n\nAdd the maven repository to the `android/build.gradle` application file:\n\n```\nallprojects {\n    repositories {\n\t\t// make sure to add this before other repos\n\t\tmaven { url \"https://cdn.veriff.me/android/\" } // \u003c------------ ADD THIS LINE\n\n        google()\n        ...\n    }\n}\n\n```\n\n### iOS\n\nadd the required permissions in your Info.plist file\n\n```\n\u003ckey\u003eNSCameraUsageDescription\u003c/key\u003e\n\u003cstring\u003eVeriff plugin needs camera permissions\u003c/string\u003e\n\u003ckey\u003eNSMicrophoneUsageDescription\u003c/key\u003e\n\u003cstring\u003eVeriff plugin needs microphone permissions\u003c/string\u003e\n\u003ckey\u003eNSPhotoLibraryUsageDescription\u003c/key\u003e\n\u003cstring\u003eVeriff plugin needs poto library access permissions\u003c/string\u003e\n\u003ckey\u003eNFCReaderUsageDescription\u003c/key\u003e\n\u003cstring\u003eVeriff plugin needs NFC permissions\u003c/string\u003e\n```\n\n\n## Install\n\n```bash\nnpm install capacitor-plugin-veriff\nnpx cap sync\n```\n\nThe plugin exposes the VERIFF JavaScript namespace which cointains a Veriff end-to-end verification service.\n\nTo use this plugin:\n\nIn your ionic app:\n\n1. Import the `VeriffPlugin` in your ionic app\n\n```javascript\nimport { VeriffPlugin } from 'capacitor-plugin-veriff';\n```\n\n2. Create a [session verification](https://developers.veriff.com/#/sessions) with your Veriff API KEY.\n\n\n2. Start the verification process:\n\nWe will need the verification sessionUrl to start the Veriff process\n\n```javascript\nconst sessionUrl = session.verification.url;\nconst configuration = {\n  themeColor: '#0F3C32'\n};\n\nconst options = {sessionUrl, configuration};\ntry {\n\tconst result = await VeriffPlugin.start(options);\n\t  // The promise returns the VeriffSDK verification result\n\t  console.log(\"Result: \", result);\n} catch(error) {\n\tconsole.error('Error starting Veriff ', error)\n}\n\n```\n\n## Building\n\nWithin root plugin path:\n\n```bash\n$ npm run build\n```\n\n## Bugs\n\n- [Bug Tracker](https://github.com/CSantosM/capacitor-plugin-veriff/issues)\n\n\n## API\n\n\u003cdocgen-index\u003e\n\n* [`start(...)`](#start)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\n### start(...)\n\n```typescript\nstart(params: { sessionUrl: string; configuration: { themeColor: string; }; }) =\u003e Promise\u003c{ message: string; status: string; }\u003e\n```\n\n| Param        | Type                                                                         |\n| ------------ | ---------------------------------------------------------------------------- |\n| **`params`** | \u003ccode\u003e{ sessionUrl: string; configuration: { themeColor: string; }; }\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ message: string; status: string; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\u003c/docgen-api\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsantosm%2Fcapacitor-plugin-veriff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsantosm%2Fcapacitor-plugin-veriff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsantosm%2Fcapacitor-plugin-veriff/lists"}