Retrieve Client Form Data

This guide demonstrates how to retrieve granular form data for a Client Form step using our API. Steps within a record can be either checks or forms; this flow covers Client Form steps only. By accessing detailed form fields and files via the Retrieve a Form for a Client endpoint, you can build more advanced automation or decisioning flows based on form responses.

Prerequisites

• Amiqus API credentials: Ensure you have valid credentials to authenticate your requests.
• Client ID: You will need the client ID, which is available on the record object when you list steps for that record.
• Form step reference: The form step object contains a reference field, which you will use to retrieve the form data.

Overview of the flow

Below is a sequence diagram illustrating the process:

Step-by-step guide

1. List all steps for a record

Call the List all steps for a record endpoint, using the record ID you wish to inspect. Locate the step where type is client_form; this object will include a reference field.

2. Retrieve the client form

Using the client ID (from the record object) and the form step’s reference, call the Retrieve a Form for a Client endpoint:

{
  "object": "client_form",
  "id": 1,
  "reference": "ddbc86b9-8ac4-475f-a8b3-5de05152f68f",
  "type": "requested",
  "client": 1,
  "record": 1,
  "fields": [
    {
      "id": "2",
      "type": "document",
      "label": "Upload a document",
      "description": "Instructions",
      "validation": [
        "required"
      ],
      "show_if": null,
      "flag": false,
      "value": [
        1
      ]
    },
    {
      "id": "3",
      "type": "section",
      "label": "",
      "fields": [
        "2"
      ]
    },
    {
      "id": "4",
      "type": "section",
      "label": "Onboarding",
      "fields": [
        "3",
        "4"
      ]
    },
    {
      "id": "5",
      "type": "text",
      "label": "Job title",
      "validation": [
        "required"
      ],
      "flag": false,
      "value": null
    },
    {
      "id": "6",
      "type": "radio",
      "label": {
        "value": "Contract type",
        "options": [
          "Full-time",
          "Part-time"
        ]
      },
      "validation": [
        "required"
      ],
      "flag": false,
      "value": null
    }
  ],
  "name": "Document Request",
  "description": null,
  "instructions": null,
  "version": 2,
  "created_at": "2025-04-24T14:23:25Z",
  "updated_at": "2025-04-24T14:23:25Z",
  "completed_at": "2025-04-24T14:23:25Z",
  "archived_at": null
}

3. Handle document-type fields (if applicable)

For any field where type is document, the value will be an array of file IDs. To download each file, call the Download a File for a Client endpoint:

This returns the raw file content (e.g. PDF, image), which you can save or process further.

What happens next?

• Store and audit: Persist form field responses (and any downloaded files) for audit trails or compliance records.
• Trigger workflows: Use form values to update your internal systems, send notifications, or route for manual review.