Submit Identity Report via the Amiqus SDK API

This guide demonstrates how to submit an identity report directly from your product using the Amiqus SDK API. Rather than redirecting your user to the Amiqus shopfront, you can collect and submit the necessary data within your own interface, providing a seamless experience.

Prerequisites

• Amiqus API credentials: Ensure you have valid credentials to authenticate your requests. For the SDK API requests, you will need to ensure you are getting a valid SDK Token. More information can be found here.
• Client and record setup: Prior to submission, you should have already created a client and a record via the Amiqus API. You can follow this guide. From the record, retrieve the relevant step ID associated with the identity report which will be used to submit the step and the record ID will be used to grant your SDK token.
• User identity data: Gather all necessary identity details (e.g. full name, date of birth and address history) through your product’s interface.

Overview of the flow

Below is a sequence diagram illustrating the process:

Step-by-step guide

1. Collect user identity data

During your user’s registration or verification process, collect the required identity information, such as:

• Title
• Date of birth
• Address history - what is required depends on the identity provider enabled on your team. In both cases the current address must be in the UK:
  • TransUnion - 12 months of address history, with the date your user moved in to each address (start)
  • Experian - only the current address is required, and move-in dates are optional. Previous addresses can be included, with or without dates

2. Create an SDK Token

Using the record ID obtained from the prerequisites, make a request to the Create an SDK token endpoint. This will generate a valid SDK token that can only be used in the SDK API for this specific record and is only valid for 60 minutes.

Example request:

{
  "record_id": "{record_id}"
}

Replace {record_id} with the actual record ID from your client and record setup.

3. Submit the identity report data

Prepare a JSON payload with the collected data. Below is an example payload for an identity report:

{
  "title": "miss",
  "dob": "1967-10-29",
  "address_history": [
    {
      "address": {
        "unit": "3rd Floor",
        "house_name": "Citypoint",
        "house_number": "65",
        "street_name": "Haymarket Terrace",
        "city": "Edinburgh",
        "postcode": "EH12 5HD",
        "country": "GB"
      },
      "start": "2019-08-24"
    }
  ],
  "privacy_policy": true
}

With Experian, start can be left out of any address_history entry.

Use the Submit a step endpoint of the Amiqus SDK API to send the identity report data. Ensure you include the SDK token obtained in Step 3 in your request.

Replace {step_id} with the actual step ID associated with the ID report provided from your previously created record.

4. Update your system

Following a successful API response, update your internal systems to reflect the new status of the identity check. Depending on your workflow, you might also receive a webhook notification from Amiqus once the check is fully processed. In either case, ensure that your user’s profile or verification status is updated appropriately.

What happens next?

Once the identity report is submitted:

1. Amiqus will process the provided data as part of its identity verification checking.
2. You can monitor the progress by polling the record details via the Amiqus API or by awaiting a webhook notification.
3. Inform your user of the verification status or any further actions required, ensuring a smooth user experience throughout the process.