# onboarding-python <img src="https://github.com/alice-biometrics/custom-emojis/blob/master/images/python.png?raw=true" width="30">
[](https://github.com/alice-biometrics/onboarding-python/releases) [](https://docs.alicebiometrics.com/onboarding/sections/server/server_side_sdks/python.html)
<img src="https://github.com/alice-biometrics/custom-emojis/blob/master/images/alice_header.png?raw=true" width=auto>
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 support@alicebiometrics.com.
## Requirements
Python 3.8+
## Installation :computer:
```console
pip install alice-onboarding
```
## Getting Started 📈
#### Config
Configure your credentials with *Config* class
```python
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`
```python
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.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding.py
```
see onboarding example [here](examples/onboarding.py)
## 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.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/auth.py
```
see auth example [here](examples/auth.py)
#### Sandbox (Only for early stages of integration)
To manage the operations with the Sandbox API, use *Sandbox* class.
```console
export ONBOARDING_SANDBOX_TOKEN="<YOUR-SANDBOX-TOKEN>"
python examples/sandbox.py
```
see sandbox example [here](examples/sandbox.py)
## 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.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_certificate.py
```
see certified onboarding usage [here](examples/onboarding_with_certificate.py)
#### User Screening
Alice Onboarding API bring us the opportunity of screening a user over different databases & lists (sanctions, PEP, etc)..
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_screening.py
```
see screening onboarding usage [here](examples/onboarding_with_screening.py)
#### Webhooks
Configure your webhooks through the api with the `Webhooks` object.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_webhooks.py
```
see onboarding webhooks usage [here](examples/onboarding_with_webhooks.py)
Note: You can configure your webhooks using the Onboarding dashboard.
## Documentation 📄
For more information about Alice Onboarding: https://docs.alicebiometrics.com/onboarding/
## Contact 📬
support@alicebiometrics.com
Raw data
{
"_id": null,
"home_page": "https://github.com/alice-biometrics/onboarding-python",
"name": "alice-onboarding",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "onboarding, biometrics, kyc, alice",
"author": "Alice Biometrics",
"author_email": "support@alicebiometrics.com",
"download_url": "https://files.pythonhosted.org/packages/a9/21/9846a7bee792f3a93ca020c8842dace627d4dad966eb973d3e3e5b545a19/alice-onboarding-5.1.1.tar.gz",
"platform": null,
"description": "# onboarding-python <img src=\"https://github.com/alice-biometrics/custom-emojis/blob/master/images/python.png?raw=true\" width=\"30\"> \n\n[](https://github.com/alice-biometrics/onboarding-python/releases) [](https://docs.alicebiometrics.com/onboarding/sections/server/server_side_sdks/python.html)\n\n\n<img src=\"https://github.com/alice-biometrics/custom-emojis/blob/master/images/alice_header.png?raw=true\" width=auto>\n\nThe aim of this Python package is to manage the authentication and backend operations against Alice Onboarding API.\n\nIf you want more information about how to integrate with Alice technology, please contact us at support@alicebiometrics.com.\n\n## Requirements\n\nPython 3.8+ \n\n## Installation :computer:\n\n```console\npip install alice-onboarding\n```\n\n## Getting Started \ud83d\udcc8\n\n#### Config \n\nConfigure your credentials with *Config* class\n\n```python\nfrom alice import Config\n\nconfig = Config(api_key=\"<YOUR-API-KEY>\")\n```\n\nBy default, this configure the `production` environment, if you\nwant to use the `sandbox` environment, you have two options:\n\n* Add `environment` parameter on `Config`\n ```python\n from alice import Config, Environment\n \n config = Config(api_key=\"<YOUR-API-KEY>\", environment=Environment.SANDBOX)\n ```\n\n#### Onboarding\n\nTo manage the operations with Alice Onboarding API, use *Onboarding* class. \nThis class deals with authentication automatically.\n\n```console\nexport ONBOARDING_API_KEY=\"<YOUR-API-KEY>\"\npython examples/onboarding.py\n```\n\nsee onboarding example [here](examples/onboarding.py)\n\n## Authentication \ud83d\udd10\n\nTo manage authorization and token creations, use *Auth* class.\n\nAvailable tokens: \n\n| Type Token | Info | \n| ----------------------- |:-------------:|\n| BACKEND_TOKEN | Used to secure global requests.| \n| BACKEND_TOKEN_WITH_USER | Used to secure global requests include user_id information embedded | \n| USER_TOKEN | Used to secure requests made by the users on their mobile devices or web clients.|\n\n\nTo create a BACKEND_TOKEN_WITH_USER and a USER_TOKEN you will need a valid user_id obtained from Alice Onboarding API.\n\n\n```console\nexport ONBOARDING_API_KEY=\"<YOUR-API-KEY>\"\npython examples/auth.py\n```\n\nsee auth example [here](examples/auth.py)\n\n\n#### Sandbox (Only for early stages of integration)\n\nTo manage the operations with the Sandbox API, use *Sandbox* class.\n\n```console\nexport ONBOARDING_SANDBOX_TOKEN=\"<YOUR-SANDBOX-TOKEN>\"\npython examples/sandbox.py\n```\n\nsee sandbox example [here](examples/sandbox.py)\n\n## Advanced features \ud83c\udfa9\n\n\u26a0\ufe0f 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.\n\n#### Certified Onboarding \n\nIf you need certify your user data, you can retrieve a certified Pdf Report with these feature.\n\n```console\nexport ONBOARDING_API_KEY=\"<YOUR-API-KEY>\"\npython examples/onboarding_with_certificate.py\n```\n\nsee certified onboarding usage [here](examples/onboarding_with_certificate.py)\n\n#### User Screening\n\nAlice Onboarding API bring us the opportunity of screening a user over different databases & lists (sanctions, PEP, etc)..\n\n```console\nexport ONBOARDING_API_KEY=\"<YOUR-API-KEY>\"\npython examples/onboarding_with_screening.py\n```\n\nsee screening onboarding usage [here](examples/onboarding_with_screening.py)\n\n\n#### Webhooks\n\nConfigure your webhooks through the api with the `Webhooks` object. \n\n```console\nexport ONBOARDING_API_KEY=\"<YOUR-API-KEY>\"\npython examples/onboarding_with_webhooks.py\n```\n\nsee onboarding webhooks usage [here](examples/onboarding_with_webhooks.py)\n\nNote: You can configure your webhooks using the Onboarding dashboard.\n\n## Documentation \ud83d\udcc4\n\nFor more information about Alice Onboarding: https://docs.alicebiometrics.com/onboarding/\n\n## Contact \ud83d\udcec\n\nsupport@alicebiometrics.com\n\n",
"bugtrack_url": null,
"license": "Alice Copyright",
"summary": "Alice Onboarding Python SDK",
"version": "5.1.1",
"project_urls": {
"Homepage": "https://github.com/alice-biometrics/onboarding-python"
},
"split_keywords": [
"onboarding",
" biometrics",
" kyc",
" alice"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b2bfebeb1dc900544d5671390631749ddf9981db63258d37fe75f885f0070aea",
"md5": "3bf147179fd0c1823f022c0908807a42",
"sha256": "5e1f3d0eff503ae76047c7b593df10f9314ecc606a1a8ed59bd868952ab332d7"
},
"downloads": -1,
"filename": "alice_onboarding-5.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3bf147179fd0c1823f022c0908807a42",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 67723,
"upload_time": "2024-03-27T09:47:00",
"upload_time_iso_8601": "2024-03-27T09:47:00.089499Z",
"url": "https://files.pythonhosted.org/packages/b2/bf/ebeb1dc900544d5671390631749ddf9981db63258d37fe75f885f0070aea/alice_onboarding-5.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a9219846a7bee792f3a93ca020c8842dace627d4dad966eb973d3e3e5b545a19",
"md5": "d45710ed60a8039e2460d34781ab5ac7",
"sha256": "d572ecb1b0258ef86f530dbdab856309ba6f2a0822c88dcd986b46d96d5c7d17"
},
"downloads": -1,
"filename": "alice-onboarding-5.1.1.tar.gz",
"has_sig": false,
"md5_digest": "d45710ed60a8039e2460d34781ab5ac7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38804,
"upload_time": "2024-03-27T09:47:02",
"upload_time_iso_8601": "2024-03-27T09:47:02.449815Z",
"url": "https://files.pythonhosted.org/packages/a9/21/9846a7bee792f3a93ca020c8842dace627d4dad966eb973d3e3e5b545a19/alice-onboarding-5.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 09:47:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alice-biometrics",
"github_project": "onboarding-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "alice-onboarding"
}
JSON
