{"id":16053885,"url":"https://github.com/nejdetkadir/verifykit","last_synced_at":"2025-08-17T21:38:38.272Z","repository":{"id":181423766,"uuid":"638617970","full_name":"nejdetkadir/verifykit","owner":"nejdetkadir","description":"The easiest and most complete unofficial VerifyKit API client for Ruby.","archived":false,"fork":false,"pushed_at":"2023-05-09T21:03:42.000Z","size":28,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-28T19:31:27.780Z","etag":null,"topics":["gem","one-time-password","otp","otp-verification","ruby","ruby-client","ruby-gem","verify","verifykit","whatsapp-otp"],"latest_commit_sha":null,"homepage":"https://docs.verifykit.com","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nejdetkadir.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-05-09T18:26:45.000Z","updated_at":"2024-01-19T22:36:07.000Z","dependencies_parsed_at":"2023-07-15T15:27:40.717Z","dependency_job_id":"c2736cda-bd98-42cb-8b50-d2338c83fce5","html_url":"https://github.com/nejdetkadir/verifykit","commit_stats":null,"previous_names":["nejdetkadir/verifykit"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nejdetkadir%2Fverifykit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nejdetkadir%2Fverifykit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nejdetkadir%2Fverifykit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nejdetkadir%2Fverifykit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nejdetkadir","download_url":"https://codeload.github.com/nejdetkadir/verifykit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232670299,"owners_count":18558567,"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","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":["gem","one-time-password","otp","otp-verification","ruby","ruby-client","ruby-gem","verify","verifykit","whatsapp-otp"],"created_at":"2024-10-09T02:01:00.090Z","updated_at":"2025-01-07T00:52:37.188Z","avatar_url":"https://github.com/nejdetkadir.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Gem Version](https://badge.fury.io/rb/verifykit.svg)](https://badge.fury.io/rb/verifykit)\n![test](https://github.com/nejdetkadir/verifykit/actions/workflows/test.yml/badge.svg?branch=main)\n![rubocop](https://github.com/nejdetkadir/verifykit/actions/workflows/rubocop.yml/badge.svg?branch=main)\n[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)\n![Ruby Version](https://img.shields.io/badge/ruby_version-\u003e=_2.7.0-blue.svg)\n\n# VerifyKit\n\n![cover](docs/cover.png)\n\nThe easiest and most complete unofficial [VerifyKit](https://verifykit.com) API client for Ruby.\n\n## Installation\n\nInstall the gem and add to the application's Gemfile by executing:\n\n```bash\n$ bundle add verifykit\n```\n\nOr add the following line to the application's Gemfile:\n\n```ruby\ngem 'verifykit', github: 'nejdetkadir/verifykit', branch: 'main'\n```\n\nIf bundler is not being used to manage dependencies, install the gem by executing:\n\n```bash\ngem install verifykit\n```\n\n## Usage\n\n### Configuration\n\n```ruby\n# config/initializers/verifykit.rb\n\nVerifyKit.configure do |config|\n  # it's optional, you can set manually when you create a VerifyKit::Client instance too\n  config.server_key = ENV.fetch('VERIFYKIT_SERVER_KEY')\n\n  # it's optional, default is Logger.new(STDOUT)\n  config.logger = Rails.logger\n\n  # it's optional, default is false\n  config.debug.enabled = true\n\n  # it's optional, default is 'v1.0', you can set manually when you create a VerifyKit::Client instance too but VerifyKit doesn't support any other version yet, so don't change it\n  config.api_version = 'v1.0'\nend\n\n# or\n\nVerifyKit.config.server_key = ENV.fetch('VERIFYKIT_SERVER_KEY')\nVerifyKit.config.logger = Rails.logger\nVerifyKit.config.debug.enabled = true\nVerifyKit.config.api_version = 'v1.0'\n```\n\n### Client\n\n```ruby\n# you can create a client instance with default configuration\nclient = VerifyKit::Client.new\n\n# or you can create a client instance with custom configuration\nclient = VerifyKit::Client.new(server_key: 'your-server-key', api_version: 'v1.0')\n```\n\n### Verification\n\nVerifyKit supports two verification methods: `sms` and `whatsapp`.\n\n#### SMS Verification\n\nSend a verification code to the phone number like this:\n\n```ruby\nclient = VerifyKit::Client.new\n\nparams = { phoneNumber: '555 555 55 55', countryCode: 'TR' }\nquery = { lang: 'tr' } # optional, default is 'en'\n\nresult = client.sms.send(params) # or client.sms.send(params, query)\n\nif result.success?\n  success_response = result.success\n  # success_response is a VerifyKit::Response::Success instance\n\n  # do something\nelse\n  error_response = result.failure\n  # error_response is a VerifyKit::Response::Error instance\n\n  # do something\nend\n```\n\nCheck the verification code like this:\n\n```ruby\nclient = VerifyKit::Client.new\n\nparams = { phoneNumber: '554 597 46 46',\n           countryCode: 'TR',\n           reference: 'reference code',\n           code: 'verification code' }\nquery = { lang: 'tr' } # optional, default is 'en'\n\nresult = client.sms.check(params) # or client.sms.check(params, query)\n\nif result.success?\n  success_response = result.success\n  # success_response is a VerifyKit::Response::Success instance\n\n  # do something\nelse\n  error_response = result.failure\n  # error_response is a VerifyKit::Response::Error instance\n\n  # do something\nend\n```\n\n#### WhatsApp Verification\n\nSend a verification code to the phone number like this:\n\n```ruby\nclient = VerifyKit::Client.new\n\nparams = { phoneNumber: '555 555 55 55', countryCode: 'TR' }\nquery = { lang: 'tr' } # optional, default is 'en'\n\nresult = client.whatsapp.send(params) # or client.whatsapp.send(params, query)\n\nif result.success?\n  success_response = result.success\n  # success_response is a VerifyKit::Response::Success instance\n\n  # do something\nelse\n  error_response = result.failure\n  # error_response is a VerifyKit::Response::Error instance\n\n  # do something\nend\n```\n\nCheck the verification code like this:\n\n```ruby\nclient = VerifyKit::Client.new\n\nparams = { reference: 'reference code',\n           code: 'verification code' }\nquery = { lang: 'tr' } # optional, default is 'en'\n\nresult = client.whatsapp.check(params) # or client.whatsapp.check(params, query)\n\nif result.success?\n  success_response = result.success\n  # success_response is a VerifyKit::Response::Success instance\n\n  # do something\nelse\n  error_response = result.failure\n  # error_response is a VerifyKit::Response::Error instance\n\n  # do something\nend\n```\n\n### Response Objects\n\n- [VerifyKit::Response::Success](lib/verify_kit/responses/success.rb)\n- [VerifyKit::Response::Error](lib/verify_kit/responses/error.rb)\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/nejdetkadir/verifykit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nejdetkadir/verifykit/blob/main/CODE_OF_CONDUCT.md).\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](LICENSE).\n\n## Code of Conduct\n\nEveryone interacting in the Verifykit project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nejdetkadir/verifykit/blob/main/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnejdetkadir%2Fverifykit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnejdetkadir%2Fverifykit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnejdetkadir%2Fverifykit/lists"}