Standard Amiqus Integration Flow

This guide walks you through creating a new Amiqus check during a user’s registration on your website. The steps focus on the key Amiqus API endpoints and the recommended webhook setup.

Prerequisites

• Webhook registration: Ensure you have configured a webhook endpoint to receive record update notifications. You can use the webhook setup guide to get started. This will allow you to track when a user has completed their Amiqus check.
• Amiqus API credentials: You will need valid credentials to call the Create a Client and Create a Record endpoints.

Overview of the flow

Below is a diagram illustrating the overall process. Once the user registers on your website and provides their details, you will create a client and then create a record in Amiqus. This can either be done by directly defining the checks, documents or forms (steps), or by using a pre-configured template. Amiqus will email the user to complete their checks, and your webhook will notify you when the checks are done.

Step-by-step guide

1. User registration on your website

During your user’s normal sign-up process, ensure you collect at least:

• Full name
• Email address

These fields are required when creating a client in Amiqus.

2. Initiate the Amiqus check workflow

2.1 Create a Client
Using the Amiqus API, create a client.
For example:

{
  "name": {
    "title": "mr",
    "first_name": "Martin",
    "middle_name": "Seamus",
    "last_name": "McFly"
  },
  "email": "marty@example.com"
}

Upon success, you will receive a client_id in the response. Store this client_id to reference later.

2.2 Create a Record
You have two options when creating a record:

• Define checks manually by passing an array of steps
• Use a predefined template by passing a template ID, which can be retrieved via the record templates endpoint

Option A: Using steps

{
  "client": 7832,
  "steps": [
    {
      "type": "check.photo_id",
      "preferences": {
        "report_type": "standard",
        "docs": [
          "passport",
          "driving_licence"
        ]
      }
    }
  ],
  "notification": "email"
}

Option B: Using a template

{
  "client": 7832,
  "template": 12,
  "notification": "email"
}

You’ll receive a record_id in the response. This record triggers the Amiqus check process and sends the invitation email to the user.

💡 Tip: If you want to notify the user outside of Amiqus, set the notification value to false. This prevents Amiqus from sending an email and instead gives you a perform_url you can share via your own channels (email, app, etc).

3. Wait for user to complete their checks

Amiqus will send your user an email (where notifications are enabled) containing a link to complete their checks. Once they have submitted the required details:

• Amiqus will update the record’s status.
• A webhook notification will be sent to the endpoint you configured, allowing you to update your system accordingly (e.g. marking a user as verified).

What happens next?

After receiving the record update webhook, you may want to:

1. Confirm the checks passed (or handle any failures/requests for more info). You could do this by retrieving the most up-to-date record to get the overall status of all the checks, or by listing all steps within a record, which will give you the status for each individual check.
2. Update your internal user profile status (e.g. “Verified”).
3. Inform your user of their successful verification.