Django app for integration with Amiqus.
Project description
# django-amiqus
Django app for integration with the Amiqus API.
The current version supports Django 3.2+ and Python 3.10+.
## Background
Amiqus is an online identity verification service. We use this library
to integrate with it.
## Amiqus workflow
There are three core entities that are modelled in this app: `Client`,
`Records`, and `Check` (pending deprecation, and soon to be renamed
`Step`). At a high level they fit together thus:
1. A `Client` represents someone against whom you wish to carry out an
identity or background check. They are unique within Amiqus, although
it's possible to carry out multiple checks over a period of time against
one user.
1. A `Record` is a suite of checks that will have an overall status that
combines the statuses of all the constituent checks.
1. A `Check` / `Step` is an individual check - it could be an identity
check, a facial recognition check, etc. See the API for all details.
### `Client`
An
## Installation
The project is available through PyPI as ``django-amiqus``:
```bash
$ pip install django-amiqus
```
## Tests
If you want to run the tests manually, install ``poetry``.
```bash
$ poetry install
$ poetry run pytest
```
If you are hacking on the project, please keep coverage up.
## Contributing
Standard GH rules apply: clone the repo to your own account, make sure you
update the tests, and submit a pull request.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django_amiqus-0.1.tar.gz
(21.7 kB
view hashes)
Built Distribution
Close
Hashes for django_amiqus-0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f4f61c01eeb888026692e6ba7e59518ce7b2a0ea7d2c37df625293a3ecfcad0 |
|
MD5 | f361721d7bd8b3c45210e7660523fd88 |
|
BLAKE2b-256 | aef573eaf903d5a5c3f946f5da0caabb60b2d36d7486664150be8341b35f2dec |