The project is in a healthy, maintained state
The Official Smile Identity gem
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 Dependencies

Development

~> 2.0
~> 12.3
~> 3.0
~> 0.12.0
~> 1.37.1
~> 0.6.0
~> 2.14.1

Runtime

~> 1.2, >= 1.2.3
~> 1.0, >= 1.0.1
 Project Readme

Smile Identity Ruby Server Side SDK

Smile 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.

If you haven’t already, sign up for a free Smile Identity account, which comes with Sandbox access.

Please see CHANGELOG.md for release versions and changes.

Features

The library exposes four classes namely; the WebApi class, the IDApi class, the Signature class, and the Utilities class.

The WebApi class has the following public methods:

The IDApi class has the following public method:

The Signature class has the following public methods:

  • generate_signature - generate a signature which is then passed as a signature param when making requests to the Smile Identity server.
  • confirm_signature - ensure a response is truly from the Smile Identity server by confirming the incoming signature.

The 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:

Installation

View the package on Rubygems.

Add this line to your application's Gemfile:

gem 'smile-identity-core'

and require the package:

require 'smile-identity-core'

Or install it to your system as:

gem install smile-identity-core

Documentation

For extensive instructions on usage of the library and sample codes, please refer to the official Smile Identity documentation.

Before that, you should take a look at the examples in the examples folder.

Getting Help

For usage questions, the best resource is our official documentation. However, if you require further assistance, you can file a support ticket via our portal or visit the contact us page on our website.

Contributing

Bug reports and pull requests are welcome on GitHub here.

License

MIT License