onboarding-python

The aim of this Python package is to manage the authentication and backend operations against Alice Onboarding API.

If you want more information about how to integrate with Alice technology, please contact us at [email protected].

Requirements

Python 3.8+

Installation 💻

pip install alice-onboarding

Getting Started 📈

Config

Configure your credentials with Config class

from alice import Config

config = Config(api_key="<YOUR-API-KEY>")

By default, this configure the production environment, if you want to use the sandbox environment, you have two options:

• Add environment parameter on Config

  from alice import Config, Environment
  
  config = Config(api_key="<YOUR-API-KEY>", environment=Environment.SANDBOX)

Onboarding

To manage the operations with Alice Onboarding API, use Onboarding class. This class deals with authentication automatically.

export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding.py

see onboarding example here

Authentication 🔐

To manage authorization and token creations, use Auth class.

Available tokens:

Type Token	Info
BACKEND_TOKEN	Used to secure global requests.
BACKEND_TOKEN_WITH_USER	Used to secure global requests include user_id information embedded
USER_TOKEN	Used to secure requests made by the users on their mobile devices or web clients.

To create a BACKEND_TOKEN_WITH_USER and a USER_TOKEN you will need a valid user_id obtained from Alice Onboarding API.

export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/auth.py

see auth example here

Sandbox (Only for early stages of integration)

To manage the operations with the Sandbox API, use Sandbox class.

export ONBOARDING_SANDBOX_TOKEN="<YOUR-SANDBOX-TOKEN>"
python examples/sandbox.py

see sandbox example here

Advanced features 🎩

⚠️ These features could not be available by default. If you obtain a HTTP Error (405 method not allowed). Please, contact us to make them available for your credentials.

Certified Onboarding

If you need certify your user data, you can retrieve a certified Pdf Report with these feature.

export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_certificate.py

see certified onboarding usage here

User Screening

Alice Onboarding API bring us the opportunity of screening a user over different databases & lists (sanctions, PEP, etc)..

export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_screening.py

see screening onboarding usage here

Webhooks

Configure your webhooks through the api with the Webhooks object.

export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_webhooks.py

see onboarding webhooks usage here

Note: You can configure your webhooks using the Onboarding dashboard.

Documentation 📄

For more information about Alice Onboarding: https://docs.alicebiometrics.com/onboarding/

Contact 📬

[email protected]