Automate Step Reviews with Custom Forms

This guide shows how to automatically review an Amiqus check based on responses to a custom form. By combining our webhook and review APIs, you can reduce manual review touch points.

This guide is suitable for developers building integrations and non-technical stakeholders who want to understand what's possible with Amiqus automation.

💡 If you're new to creating clients and issuing checks, start with our Standard Integration Flow.

Prerequisites

Before starting this guide, you should already have:

• Created a Client and Record using the registration flow
• Registered a webhook to listen for record.finished events
• Retained the Record ID, Step ID and Reference for the custom form check within the record
• Amiqus API credentials with access to the necessary endpoints

Overview of the automation flow

Step-by-step guide

1. Wait for the record.finished webhook

Once the client completes all steps, your registered webhook will receive a record.finished event. This means the check is ready for review.

Webhook documentation: record.finished

📝 You must store the Record ID and associated Step ID(s) when the record is first created, as these are needed later to submit a review.

2. Retrieve the form data

When you create a record, Amiqus returns an array of steps in the response. For any step of type form (sometimes referred to as a Client Form), the form field contains a unique reference. This is the reference you’ll use to retrieve the submitted form data.

⚠️ Although the API docs mention client_form, the field you need is found under the form property in the step object when you create a record.

✅ If you've already stored the form reference from the record creation response, you can skip listing the steps.

If you do not have the form reference stored:

• List all steps for the record
• Identify the step with "type": "form"
• Extract the form field — this is the reference you’ll use

Then call the Retrieve a Form for a Client endpoint.

This will return the submitted form data, including field values, types, and labels.

3. Apply your business logic

You can now apply your own logic to determine whether the check passes. For example, in a staff vetting use case:

• If the form includes a field called "Contract type" and the value is "Full-time"
• And a field "Job title" is not blank

...then you may choose to auto-approve the check.

Example pseudo-logic:

if (form["Contract type"] === "Full-time" && form["Job title"] !== "") {
    review = "approved";
} else {
    review = "rejected";
}

✅ You are free to define any review logic that makes sense for your use case.

4. Submit a step review

Use the Create a Review for a Step endpoint to submit your review. Example payload:

{
  "review": "approved",
  "message": "Auto-reviewed: contract is full-time and job title provided."
}

5. Mark the record as reviewed

After all step reviews are submitted, finalise the record by calling:

Mark Record as Reviewed

What happens next?

Once reviewed, the record's status is updated in Amiqus and will reflect in the dashboard. You can notify internal systems or trigger next steps (e.g. onboarding a new hire) based on the result.

Summary

By combining our webhook, form retrieval, and review APIs, you can:

• Build low-touch automated decision flows
• Reduce manual review effort for known safe scenarios
• Integrate Amiqus checks more deeply into your business logic