smile-identity-core

Smile Identity Node.js 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; the WebApi class, the IDApi class, the Signature class, and the Utilities class.

The WebApi class has the following public methods:

• submit_job - handles submission of any of Smile Identity products that requires an image i.e. Biometric KYC, Document Verification and SmartSelfieTM Authentication.
• get_job_status - retrieve information & results of a job. Read more on job status in the Smile Identity documentation.
• get_web_token - handles generation of web token, if you are using the Hosted Web Integration.

The IDApi class has the following public method:

• submit_job - handles submission of Enhanced KYC, Basic KYC and Business Verification.

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:

• get_job_status - retrieve information & results of a job. Read more on job status in the Smile Identity documentation.

For examples of how to use these classes, please see the examples directory of this repository.

Installation

Note This package requires node 12.x or higher.

View the package on npm.

This package can be added to your project as:

npm install --save smile-identity-core

Documentation

This package requires specific input parameters, for more detail on these parameters please refer to our documentation for Web API.

Please note that you will have to be a Smile Identity Partner to be able to query our services. You can sign up on the Portal.

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

Changelog

[3.1.0] - 2024-01-31

Added

• Added support for asynchronous jobs for ID and Business verifications.