Skip to main content

The official Smile Identity package exposes four classes namely; the WebApi class, the IDApi class, the Signature class and the Utilities class.

Project description

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

The library exposes five classes; the WebApi class, the IDApi class, the Signature class, the Utilities class and the BusinessVerification class.

The IDApi class has the following public method:

The Signature class has the following public methods:

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.

  • BusinessVerification - This is an API class that lets you perform Business verification Services(KYB). This product lets you search the registration of a business from supported countries and return the company's information, directors, beneficial owners and fiduciaries of a business while the tax information returns only the company information. Business Verification.

Installation

Note This package requires python3.8 or higher.

This package can be added to your project as:

pip install smile-id-core

Development

To install this package, along with the tools you need to develop and run tests, run the following command:

poetry install --with dev

To run the tests, run the following command:

poetry run pytest

Install pre-commit hooks to format code before committing.

poetry run pre-commit install

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

smile_id_core-3.0.1.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

smile_id_core-3.0.1-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file smile_id_core-3.0.1.tar.gz.

File metadata

  • Download URL: smile_id_core-3.0.1.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.11

File hashes

Hashes for smile_id_core-3.0.1.tar.gz
Algorithm Hash digest
SHA256 e38b952f4969225cae53b7cb8b5ba71196547a73708892ecdf1c707bae22bcf3
MD5 af53e975587632853a97d31abff94918
BLAKE2b-256 a7414f75575b922cdc15741f6d2a3a6aacc23ebc63e88183cdedb700af44fb68

See more details on using hashes here.

File details

Details for the file smile_id_core-3.0.1-py3-none-any.whl.

File metadata

  • Download URL: smile_id_core-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.11

File hashes

Hashes for smile_id_core-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2510a206cb98386a5a2700f81641ad66ae75a2b943926c4217814f6325d470f3
MD5 41d0773b55737b5d95350a3120ede41f
BLAKE2b-256 6272c8509f42ee2d74b8e58cb582473a66769767a979d690777a42291dec0076

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page