{"id":22477054,"url":"https://github.com/smileidentity/smile-identity-core-ruby","last_synced_at":"2025-08-02T13:30:43.142Z","repository":{"id":37580167,"uuid":"197731259","full_name":"smileidentity/smile-identity-core-ruby","owner":"smileidentity","description":"The Official Smile Identity Ruby Gem","archived":false,"fork":false,"pushed_at":"2025-01-09T12:02:32.000Z","size":239,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-28T15:55:03.664Z","etag":null,"topics":["gem","ruby"],"latest_commit_sha":null,"homepage":"https://docs.smileidentity.com","language":"Ruby","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/smileidentity.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2019-07-19T08:11:37.000Z","updated_at":"2025-01-23T04:55:57.000Z","dependencies_parsed_at":"2024-04-01T17:46:29.027Z","dependency_job_id":"7fe6c00f-1348-4548-b6f9-504358b3e494","html_url":"https://github.com/smileidentity/smile-identity-core-ruby","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/smileidentity/smile-identity-core-ruby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smileidentity%2Fsmile-identity-core-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smileidentity%2Fsmile-identity-core-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smileidentity%2Fsmile-identity-core-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smileidentity%2Fsmile-identity-core-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smileidentity","download_url":"https://codeload.github.com/smileidentity/smile-identity-core-ruby/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smileidentity%2Fsmile-identity-core-ruby/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268214224,"owners_count":24214352,"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-01T02:00:08.611Z","response_time":67,"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":["gem","ruby"],"created_at":"2024-12-06T14:09:23.612Z","updated_at":"2025-08-02T13:30:42.759Z","avatar_url":"https://github.com/smileidentity.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Smile Identity Ruby Server Side SDK\n\nSmile Identity provides the best solutions for real time Digital KYC, identity verification, user onboarding, and user authentication across Africa. Our server side libraries make it easy to integrate us on the server-side. Since the library is server-side, you will be required to pass the images (if required) to the library.\n\nIf you haven’t already, [sign up for a free Smile Identity account](https://usesmileid.com/talk-to-an-expert/), which comes with Sandbox access.\n\nPlease see [CHANGELOG.md](CHANGELOG.md) for release versions and changes.\n\n## Features\n\nThe library exposes four classes namely; the WebApi class, the IDApi class, the Signature class, and the Utilities class.\n\nThe WebApi class has the following public methods:\n\n- `submit_job` - handles submission of any of Smile Identity products that requires an image i.e. [Biometric KYC](https://docs.usesmileid.com/products/biometric-kyc), [Document Verification](https://docs.usesmileid.com/products/document-verification), [SmartSelfieTM Authentication](https://docs.usesmileid.com/products/biometric-authentication) and [Business Verification](https://docs.usesmileid.com/products/for-businesses-kyb/business-verification).\n- `get_web_token` - handles generation of web token, if you are using the [Hosted Web Integration](https://docs.usesmileid.com/web-mobile-web/web-integration-beta).\n\nThe IDApi class has the following public method:\n\n- `submit_job` - handles submission of [Enhanced KYC](https://docs.usesmileid.com/products/identity-lookup) and [Basic KYC](https://docs.usesmileid.com/products/id-verification).\n\nThe Signature class has the following public methods:\n\n- `generate_signature` - generate a signature which is then passed as a signature param when making requests to the Smile Identity server.\n- `confirm_signature` - ensure a response is truly from the Smile Identity server by confirming the incoming signature.\n\nThe Utilities Class allows you as the Partner to have access to our general Utility functions to gain access to your data. It has the following public methods:\n\n- `get_job_status` - retrieve information \u0026 results of a job. Read more on job status in the [Smile Identity documentation](https://docs.usesmileid.com/further-reading/job-status).\n\n## Installation\n\nView the package on [Rubygems](https://rubygems.org/gems/smile-identity-core).\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'smile-identity-core'\n```\n\nand require the package:\n\n```ruby\nrequire 'smile-identity-core'\n```\n\nOr install it to your system as:\n\n```shell\ngem install smile-identity-core\n```\n\n## Documentation\n\nFor extensive instructions on usage of the library and sample codes, please refer to the official Smile Identity [documentation](https://docs.usesmileid.com/server-to-server/ruby).\n\nBefore that, you should take a look at the examples in the [examples](/examples) folder.\n\n## Getting Help\n\nFor usage questions, the best resource is [our official documentation](https://docs.usesmileid.com). However, if you require further assistance, you can file a [support ticket via our portal](https://portal.usesmileid.com/partner/support/tickets) or visit the [contact us page](https://portal.usesmileid.com/partner/support/tickets) on our website.\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub [here](https://github.com/smileidentity/smile-identity-core-ruby).\n\n## License\n\nMIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmileidentity%2Fsmile-identity-core-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmileidentity%2Fsmile-identity-core-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmileidentity%2Fsmile-identity-core-ruby/lists"}