Warning
Deprecated: This package is deprecated and will no longer receive support. Please do not rely on this public version for new projects but the code will remain for anyone who has existing reliance on it.
Django app for integration with the Amiqus API.
The current version supports Django 5.2-6.0 and Python 3.12+.
Amiqus is an online identity verification service. We use this library to integrate with it.
Core entities included in this app are Client, Record, Step, Check, Form, and Review
Represents a person against whom you wish to carry out an identity or background check. They are unique within Amiqus, although it is possible to carry out multiple checks over a period of time against one user.
A collection of Steps that a Client is required to complete. The Client receives a link where
they are presented with the various Steps.
Can be either a Check or a Form. The Amiqus platform does support Document type Steps, but
these are not currently supported by this package.
May each be of the types described in Check.CheckType. This includes things like photo ID
verification and watchlist monitoring.
Defined in the Amiqus platform and consists of one or more questions that the Client must answer.
Each Step may be reviewed in the Amiqus interface. This creates a Review object that can be
queried via the API .
The project is available through PyPI as django-amiqus:
$ pip install django-amiqusIf you want to run the tests manually, install poetry.
$ poetry install
$ poetry run pytestIf you are hacking on the project, please keep coverage up.
Standard GH rules apply: clone the repo to your own account, make sure you update the tests, and submit a pull request.