Amiqus Developers

Appearance

Endpoints for managing a team's requests, checks and forms. ​

List enabled check types ​

v1GEThttps://id.amiqus.co/api/checks
v2GEThttps://id.amiqus.co/api/v2/steps

Please note that the url for this endpoint has been updated from /checks to /steps.

Each of the different checks, documents and forms that are comprised within a single request have been consolidated to be collectively referred to as steps (formerly checks). Further detail on the fields used in v2 are outlined below:

Field nameDefinition
stepThe collective name for each of the checks, forms, and documents that make up a single request. List all steps will list those steps that are enabled on the team.
checkThe types of checks that are part of a request or enabled on the team such as a criminal record check (check.criminal_record).
formA form that that is part of a request or enabled on the team (form).
documentThe types of documents that are part of a request or enabled on the team such as a document request (document.request).

This endpoint now returns a paginated list object (see the Pagination Guide for more information). Where v1 contained, depending on the check type, many different properties in the response, v2 has removed most of these properties and simplified the different step types.

Added

  • “object": "paginated_list"
  • "object": "available_step"
  • costs

Changed

  • The type field remains but the values are different e.g. check.dummy , formerly dummy.

Below are examples of responses:

json
{
    "data": [
        {
            "type": "dummy",
            "label": "Dummy Check",
            "description": "Run a dummy check to demonstrate the request process.",
            "has_configuration": true,
            "active": true,
            "region_label": "UK only",
            "configured": true,
            "config": {
                "state": {
                    "type": "select",
                    "label": "Automatic Verification State",
                    "note": "Automatically set the check status without carrying out a request.",
                    "options": {
                        "0": "Don't automatically verify",
                        "2": "Accepted",
                        "3": "Rejected",
                        "4": "Refer",
                        "5": "Failed",
                        "6": "Paused"
                    },
                    "default": 0
                },
                "replay": {
                    "type": "checkbox",
                    "label": "Allow failed replay",
                    "checked": true,
                    "note": "Enable \"re-submit\" action when check has failed."
                }
            },
            "silent": false,
            "cost": 1,
            "all_costs": [
                1
            ]
        },
        {
            "type": "documents_requested",
            "label": "Document Request",
            "description": "Securely collect documents such as signed contracts,bank statements or references.",
            "has_configuration": false,
            "active": true,
            "region_label": "Global",
            "configured": true,
            "config": [],
            "silent": false,
            "cost": 0,
            "all_costs": [
                0
            ]
        }
    ]
}
json
{
    "object": "paginated_list",
    "data": [
        {
            "object": "available_step",
            "type": "check.identity",
            "costs": [
                1
            ]
        },
        {
            "object": "available_step",
            "type": "check.photo_id",
            "costs": [
                1,
                2,
                3,
                4
            ]
        },
        {
            "object": "available_step",
            "type": "check.watchlist",
            "costs": [
                2,
                3,
                4
            ]
        },
        {
            "object": "available_step",
            "type": "document.request",
            "costs": [
                0
            ]
        },
        {
            "object": "available_step",
            "type": "document.transfer",
            "costs": [
                0
            ]
        }
    ],
    "total": 5,
    "count": 5,
    "limit": 100,
    "current_page": 1,
    "total_pages": 1,
    "links": null
}

INFO

📌 Please refer to List all steps for more information.

List all requests ​

v1GEThttps://id.amiqus.co/api/records
v2GEThttps://id.amiqus.co/api/v2/records

Request:

Added

  • status
  • creator
  • expand
  • client_visibility return records from only archived or active clients. Records from all clients are included by default in v2.

Changed

  • assignee no longer accepts the value “unassigned”
  • Accepted values for visibility have changed:
    • v1 accepted either archived or all and returned only active records by default.
    • v2 accepts either archived or active and returns both active and archived records by default.

Removed

  • user replaced with creator
  • organisation
  • reference
  • q
  • include_archived_clients included records for archived clients which were omitted by default. Replaced by client_visibility.

Response:

Added

  • data.*.object is always “record” and refers to the object’s type

Changed

  • data.*.status Now returns an enum value which is the text representation of the status instead of a number. E.g. instead of 5, it now returns “empty”. See API v2 documentation for full list of possible values.
  • data.*.steps Now returns an array of objects of type step associated with this record
  • data.*.client_id Renamed to data.*.client
  • data.*.client ID of the client associated with this record (expandable to full object of type client)
  • data.*.links is replaced with data.*.perform_url

Removed

  • data.*.expired_at
  • data.*.author
  • data.*.user_id
  • data.*.company
  • data.*.reference
  • data.*.details
  • data.*.message
  • data.*.send_reminder
  • data.*.emailed_at
  • data.*.expired_at
  • data.*.consented_at
  • data.*.reviewed_at
  • data.*.jurisdiction
  • data.*.snapshot
  • data.*.full_name
  • data.*.status_label
  • data.*.expired
  • data.*.archived
  • data.*.finished
  • data.*.can_be_archived
  • data.*.can_be_expired
  • data.*.can_be_refreshed
  • data.*.can_be_completed
  • data.*.can_be_reviewed
  • data.*.deprecated
  • data.*.pending_amendments
  • data.*.is_silent
  • data.*.checks
  • data.*.assignees

Note:

  • Results previously sorted by created_at in descending order are now sorted in ascending order by default.
  • v1 returned active records only and omitted records belonging to archived clients by default. v2 now returns both active and archived records by default, including those belonging to archived clients.

Below are examples of responses:

json
{
    "data": [
        {
            "id": 1,
            "author": {
                "id": 1,
                "name": "Test Team",
                "contact": "allen.sophia@example.com",
                "telephone": "09344 32923",
                "logo": null,
                "uuid": "51a36116-86a3-4ca0-aa7e-f33c94419076",
                "credits": 392,
                "low_credits": null,
                "tier": "large",
                "support_access": false,
                "live_at": null,
                "archived_at": null,
                "created_at": "2018-08-28 13:04:45",
                "updated_at": "2018-08-28 13:04:45"
            },
            "client_id": 1,
            "user_id": 3,
            "name": "Mia Lee",
            "email": "mia@example.com",
            "company": null,
            "reference": "AHUHZWB4",
            "details": {
                "middle_name": "Jane",
                "title": "Ms.",
                "landline": "0897 6252968",
                "mobile": "+9843790614066",
                "address": null,
                "dob": "1940-04-19"
            },
            "message": null,
            "send_reminder": false,
            "archived_at": null,
            "expired_at": "2018-09-08T17:31:32+00:00",
            "emailed_at": false,
            "created_at": "2018-08-29T17:31:32+00:00",
            "updated_at": "2018-08-29T17:31:32+00:00",
            "jurisdiction": null,
            "client": {
                "first_name": "Mia",
                "last_name": "Lee"
            },
            "status": 0,
            "status_label": "Not started by client",
            "expired": false,
            "archived": false,
            "can_be_expired": true,
            "can_be_refreshed": false,
            "pending_checks": 1,
            "pending_amendments": 0,
            "links": {
                "show": "/clients/1/records/1",
                "download": "/records/1/download",
                "perform": "https://id.amiqus.co/i/0vz32B9CZpO1yLsKPdy9q"
            },
            "checks": {
                "data": [
                    {
                        "id": 1,
                        "type": "dummy",
                        "label": "Dummy Check",
                        "label_full": "Dummy check",
                        "client": "Mia Lee",
                        "status": 0,
                        "status_label": "Awaiting completion.",
                        "state": "pending",
                        "allow_replay": false,
                        "created_at": "2018-08-29T17:31:32+00:00",
                        "updated_at": "2018-08-29T17:31:32+00:00",
                        "submitted_at": null,
                        "requires_consent": true,
                        "links": {
                            "record": "https://id.amiqus.co/clients/1/records/1",
                            "api": {
                                "show": "https://id.amiqus.co/api/records/1/checks/1"
                            }
                        }
                    }
                ]
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 25,
            "current_page": 1,
            "total_pages": 1,
            "links": []
        }
    }
}
json
{
    "object": "paginated_list",
    "data": [
        {
            "object": "record",
            "id": 983434,
            "status": "pending",
						"perform_url": "https://id.amiqus.co/i/sFvAK0UYqJ7YENJ7vmvPd",
            "email": "marty@example.com",
            "steps": [
                {
                    "object": "step",
                    "id": 2,
                    "type": "check.photo_id",
                    "preferences": {
                        "report_type": "standard",
                        "face": true,
                        "liveness": true,
                        "facial_similarity": false,
                        "live_document": false,
                        "docs": [
                            "passport",
                            "driving_licence",
                            "national_id"
                        ]
                    },
                    "check": 82342,
                    "cost": 1,
                    "completed_at": null
                },
                {
                    "object": "step",
                    "id": 3,
                    "type": "document.request",
                    "preferences": {
                        "title": "Utility bill",
                        "instructions": "A utility bill dated within the last three months."
                    },
                    "document": 23123,
                    "cost": 0,
                    "completed_at": null
                },
                {
                    "object": "step",
                    "id": 4,
                    "type": "form",
                    "form": "4bd9bfca-e61d-4a68-99b3-ca61a02f650f",
                    "cost": 0,
                    "completed_at": null
                }
            ],
            "client": 73845,
            "created_at": "2022-05-22T08:22:12Z",
            "updated_at": "2022-05-22T08:22:12Z",
            "archived_at": null,
            "is_declaration_required": false,
            "declaration_confirmed_at": null
        }
    ],
    "total": 1,
    "count": 1,
    "limit": 100,
    "current_page": 1,
    "total_pages": 1,
    "links": null
}

INFO

📌 Please refer to List all records for more information.

Additional Record Properties (Steps, Documents and Assignees). ​

The following expandable properties are no longer available when when retrieving a record or a list of records: checks, document, assignee. These properties have been replaced with new dedicated endpoints.

Changed

List a given client's requests ​

Response:

INFO

📌 Please refer to List all records for a client for more information.

List a given client's forms ​

v1GEThttps://id.amiqus.co/api/clients/{id}/forms
v2GEThttps://id.amiqus.co/api/v2/clients/{id}/forms

“List a given client’s forms” endpoint has been replaced with “Clients → List all forms for a client”

Added

  • data.*.object is always “client_form” and refers to the object’s type
  • data.*.type indicates if the form is for data collection or requested for completion by client
  • data.*.client is the ID of the client associated with this form
  • data.*.record is an optional ID of record associated with this form

Changed

  • data.*.description now returns null instead of empty string if empty
  • data.*.client_id has been renamed to data.*.client
  • data.*.record_id has been renamed to data.*.record
  • data.*.fields.*.hint This has been renamed with data.fields.*.description

Note: In v1, some properties were not returned in the response if they were empty, e.g. data.*.fields.*.show_if. However, in v2, all properties are returned, even if empty.

Removed

  • data.*.status
  • data.*.user_id
  • data.*.team_id
  • data.*.progress
  • data.*.links

Below are examples of responses:

json
{
    "object": "paginated_list",
    "data": [
        {
            "object": "client_form",
            "id": 37344,
            "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",
            "type": "requested",
            "client": 73212,
            "record": 87564,
            "name": "New starter form",
            "description": null,
            "instructions": null,
            "fields": [
                {
                    "id": "1",
                    "type": "section",
                    "label": "",
                    "fields": [
                        "2"
                    ]
                },
                {
                    "id": "2",
                    "type": "section",
                    "label": "Onboarding",
                    "fields": [
                        "3",
                        "4"
                    ]
                },
                {
                    "id": "3",
                    "type": "text",
                    "label": "Job title",
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": null
                },
                {
                    "id": "4",
                    "type": "radio",
                    "label": {
                        "value": "Contract type",
                        "options": [
                            "Full-time",
                            "Part-time"
                        ]
                    },
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": null
                }
            ],
            "version": 1,
            "created_at": "2022-10-11T13:41:38Z",
            "updated_at": "2022-10-11T13:41:38Z",
            "completed_at": null,
            "archived_at": null
        },
        {
            "object": "client_form",
            "id": 37523,
            "reference": "4fdb5ab5-f83e-4b52-926b-340e880bb030",
            "type": "internal",
            "client": 73212,
            "record": null,
            "name": "Onboarding checklist",
            "description": "Checklist for all new employees.",
            "instructions": null,
            "fields": [
                {
                    "id": "1",
                    "type": "section",
                    "label": "",
                    "fields": [
                        "2",
                        "3"
                    ]
                },
                {
                    "id": "2",
                    "type": "radio",
                    "label": {
                        "value": "Location",
                        "options": [
                            "Office",
                            "Remote",
                            "Hybrid"
                        ]
                    },
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": "Remote"
                },
                {
                    "id": "3",
                    "type": "radio",
                    "label": {
                        "value": "Department",
                        "options": [
                            "Sales",
                            "Marketing",
                            "Legal",
                            "Admin"
                        ]
                    },
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": "Admin"
                }
            ],
            "version": 2,
            "created_at": "2022-11-02T15:55:38Z",
            "updated_at": "2022-11-05T20:02:06Z",
            "completed_at": null,
            "archived_at": null
        }
    ],
    "total": 2,
    "count": 2,
    "limit": 100,
    "current_page": 1,
    "total_pages": 1,
    "links": null
}
json
{
    "object": "paginated_list",
    "data": [
        {
            "object": "client_form",
            "id": 37344,
            "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",
            "type": "requested",
            "client": 73212,
            "record": 87564,
            "name": "New starter form",
            "description": null,
            "instructions": null,
            "fields": [
                {
                    "id": "1",
                    "type": "section",
                    "label": "",
                    "fields": [
                        "2"
                    ]
                },
                {
                    "id": "2",
                    "type": "section",
                    "label": "Onboarding",
                    "fields": [
                        "3",
                        "4"
                    ]
                },
                {
                    "id": "3",
                    "type": "text",
                    "label": "Job title",
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": null
                },
                {
                    "id": "4",
                    "type": "radio",
                    "label": {
                        "value": "Contract type",
                        "options": [
                            "Full-time",
                            "Part-time"
                        ]
                    },
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": null
                }
            ],
            "version": 1,
            "created_at": "2022-10-11T13:41:38Z",
            "updated_at": "2022-10-11T13:41:38Z",
            "completed_at": null,
            "archived_at": null
        },
        {
            "object": "client_form",
            "id": 37523,
            "reference": "4fdb5ab5-f83e-4b52-926b-340e880bb030",
            "type": "internal",
            "client": 73212,
            "record": null,
            "name": "Onboarding checklist",
            "description": "Checklist for all new employees.",
            "instructions": null,
            "fields": [
                {
                    "id": "1",
                    "type": "section",
                    "label": "",
                    "fields": [
                        "2",
                        "3"
                    ]
                },
                {
                    "id": "2",
                    "type": "radio",
                    "label": {
                        "value": "Location",
                        "options": [
                            "Office",
                            "Remote",
                            "Hybrid"
                        ]
                    },
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": "Remote"
                },
                {
                    "id": "3",
                    "type": "radio",
                    "label": {
                        "value": "Department",
                        "options": [
                            "Sales",
                            "Marketing",
                            "Legal",
                            "Admin"
                        ]
                    },
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": "Admin"
                }
            ],
            "version": 2,
            "created_at": "2022-11-02T15:55:38Z",
            "updated_at": "2022-11-05T20:02:06Z",
            "completed_at": null,
            "archived_at": null
        }

    ],
    "total": 2,
    "count": 2,
    "limit": 100,
    "current_page": 1,
    "total_pages": 1,
    "links": null
}

INFO

📌 Please refer to List all forms for a client for more information.

List a given client's documents ​

v1GEThttps://id.amiqus.co/api/clients/{id}/files
v2GET[https://id.amiqus.co/api/v2/clients/{id}/files] (https://developers.amiqus.co/aqid/api-reference.html#operation/get-clients-id-files)

“List a given client’s documents” endpoint has been replaced with “Clients → List all files for a client”.

Request:

Added

  • source

Removed

  • id

Response:

Added

  • data.*.object is always “client_file” and refers to the object’s type
  • data.*.attachment contains some of the file related properties from API v1
    • object is always “attachment” and refers to the object’s type
    • id
    • name
    • original
    • type
    • size
    • av_status
    • created_at
    • updated_at

Changed

  • data.*.type is now an enum that refers to the how file was added. Visit the API v2 documentation for details about the values available. The file’s type (e.g. application/pdf) has been moved to data.*.attachment.type
  • data.*.source is now an object representing the client file’s source. Visit the API v2 documentation for details about the type of client files available.

Removed

  • data.*.name has been replaced with data.*.attachment.name
  • data.*.original has been replaced with data.*.attachment.original
  • data.*.type has been replaced with data.*.attachment.type
  • data.*.size has been replaced with data.*.attachment.size
  • data.*.deletable
  • data.*.av_status has been replaced with data.*.attachment.av_status
  • data.*.author
  • data.*.user_id
  • data.*.team_id
  • data.*.links
  • data.*.client
  • data.*.user

Below are examples of responses:

json
{
    "data": [
        {
            "id": 111,
            "name": "fdsafdgdsgfds.pdf",
            "original": "Contract.pdf",
            "type": "application/pdf",
            "size": 16053,
            "author": "123-456-789",
            "team_id": 1,
            "user_id": 3,
            "deletable": false,
            "av_status": "CLEAN",
            "created_at": "2022-01-06T11:59:25+00:00",
            "updated_at": "2022-01-06T11:59:26+00:00",
            "links": {
                "download": "https://id.amiqus.co/team/attachments/17"
            },
            "source": {
                "label": "Sent",
                "link": "https://id.amiqus.co/clients/1/records/12",
                "properties": {
                    "name": "Contract",
                    "message": "Please see attached the contract"
                }
            },
            "client": "Mia Lee",
            "user": {
                "id": 3,
                "name": "Sophie Allen",
                "email": "allen.sophia@example.com",
                "email_change_to": null,
                "is_assumed": false,
                "verified": true,
                "disabled": false,
                "has_access": true,
                "created_at": "2021-07-12T16:30:10+00:00",
                "updated_at": "2021-10-08T13:46:41+00:00"
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 25,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}
json
{
    "object": "paginated_list",
    "data": [
        {
            "object": "client_file",
            "id": 31782,
            "type": "internal",
            "source": {
                "id": 31788,
                "type": "client"
            },
            "name": "fdsafdgdsgfds.pdf",
            "attachment": {
                "object": "attachment",
                "id": 31782,
                "name": "fdsafdgdsgfds.pdf",
                "original": "Contract.pdf",
                "type": "application/pdf",
                "size": 16053,
                "av_status": "clean",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z"
            },
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ],
    "total": 1,
    "count": 1,
    "limit": 100,
    "current_page": 1,
    "total_pages": 1,
    "links": null
}

INFO

📌 Please refer to List all files for a client for more information.

Create a request ​

v1POSThttps://id.amiqus.co/api/records
v2POSThttps://id.amiqus.co/api/v2/records

“Create a request” endpoint has been replaced with “Records → Create a record”

Individual properties for checks, forms and documents have been removed and they are now created by adding objects to a new steps property.

Request:

Added

  • steps An array of steps. See API v2 documentation for a list of possible values.
  • notification
  • client
  • reminder

Removed

  • send_reminder has been renamed to reminder
  • send_email has been renamed to notification. Set to false not to send an email and email to send an email notification
  • client_id has been renamed to client
  • checks have been removed and are now created by checks to the steps array. Check the v2 documentation for how to add check steps
  • custom_forms: Custom forms are now associated with a request by adding them to the steps array. Check the v2 documentation for how to add form steps
  • documents_requested: Requested documents are now added by adding them to the steps array. Check the v2 documentation for how to add a requested document.
  • documents_sent: Document transfers are now added by adding them to the steps array. Check the v2 documentation for how to add a document transfer.
  • reset_client_status
  • first_name
  • last_name
  • email
  • reference
  • organisations
  • organisation_name
  • company_number
  • jurisdiction

Note:

  • It is no longer possible to create an organisation when creating a request. Please see Create an organisation.
  • It is no longer possible to submit the client’s name, email, reference etc. You must now use the client ID of an already existing client.

Response:

The response will be an object of type record. See the List all requests migration notes for changes and notes.

Below are examples of responses:

json
{
    "id": 1,
    "author": {
        "id": 1,
        "name": "Test Team",
        "contact": "allen.sophia@example.com",
        "telephone": "09344 32923",
        "logo": null,
        "uuid": "51a36116-86a3-4ca0-aa7e-f33c94419076",
        "credits": 392,
        "low_credits": null,
        "tier": "large",
        "support_access": false,
        "live_at": null,
        "archived_at": null,
        "created_at": "2018-08-28 13:04:45",
        "updated_at": "2018-08-28 13:04:45"
    },
    "client_id": 1,
    "user_id": 3,
    "name": "Mia Lee",
    "email": "mia@example.com",
    "company": null,
    "reference": "AHUHZWB4",
    "details": {
        "middle_name": "Jane",
        "title": "Ms.",
        "landline": "0897 6252968",
        "mobile": "+9843790614066",
        "address": null,
        "dob": "1940-04-19"
    },
    "message": "Lorem ipsum dolor sit amet.",
    "send_reminder": false,
    "archived_at": null,
    "expired_at": "2018-09-08T17:31:32+00:00",
    "emailed_at": false,
    "created_at": "2018-08-29T17:31:32+00:00",
    "updated_at": "2018-08-29T17:31:32+00:00",
    "jurisdiction": null,
    "client": {
        "first_name": "Mia",
        "last_name": "Lee"
    },
    "status": 0,
    "status_label": "Not started by client",
    "expired": false,
    "archived": false,
    "can_be_expired": true,
    "can_be_refreshed": false,
    "pending_checks": 1,
    "pending_amendments": 0,
    "links": {
        "show": "/clients/1/records/1",
        "download": "/records/1/download",
        "perform": "https://id.amiqus.co/i/0vz32B9CZpO1yLsKPdy9q"
    }
}
json
{
    "object": "record",
    "data": [
        {
            "id": 983434,
            "status": "pending",
            "perform_url": "https://id.amiqus.co/i/0vz32B9CZpO1yLsKPdy9q",
            "email": "marty@example.com",
            "steps": [
                {
                    "object": "step",
                    "id": 2,
                    "type": "check.photo_id",
                    "preferences": {
                        "report_type": "standard",
                        "face": true,
                        "liveness": true,
                        "facial_similarity": false,
                        "live_document": false,
                        "docs": [
                            "passport",
                            "driving_licence",
                            "national_id"
                        ]
                    },
                    "check": 82342,
                    "cost": 1,
                    "completed_at": null
                },
                {
                    "object": "step",
                    "id": 3,
                    "type": "document.request",
                    "preferences": {
                        "title": "Utility bill",
                        "instructions": "A utility bill dated within the last three months."
                    },
                    "document": 23123,
                    "cost": 0,
                    "completed_at": null
                },
                {
                    "object": "step",
                    "id": 4,
                    "type": "form",
                    "form": "4bd9bfca-e61d-4a68-99b3-ca61a02f650f",
                    "cost": 0,
                    "completed_at": null
                }
            ],
            "client": 73845,
            "created_at": "2022-05-22T08:22:12Z",
            "updated_at": "2022-05-22T08:22:12Z",
            "archived_at": null,
            "is_declaration_required": false,
            "declaration_confirmed_at": null
        }
    ],
}

INFO

📌 Please refer to Create a record for more information.

Show a single request ​

v1GEThttps://id.amiqus.co/api/records/{id}
v2GEThttps://id.amiqus.co/api/v2/records/{id}

“Show a single request” endpoint has been replaced with “Records → Retrieve a record”

Request:

Changed

  • expand Now only accepts the string value client in order to return the full object of type client under the client property instead of just the client ID. Bothchecks and documents are no longer valid values.

Response:

The response will be an object of type record. See the “List all requests” migration notes for changes and notes.

Get a PDF version of a request ​

v1GEThttps://id.amiqus.co/api/records/{id}/download
v2GEThttps://id.amiqus.co/api/v2/records/{id}/download

“Get a PDF version of a request” endpoint has been replaced with “Records → Download a record”

WARNING

Please note that v1 simply opened the link to a pdf version of a request. v2 will initiate the download automatically.

INFO

📌 Please refer to Download a record for more information.

Show a single form ​

v1GEThttps://id.amiqus.co/api/clients/{id}/forms/{reference}
v2GET https://id.amiqus.co/api/v2/clients/{id}/forms/{reference}

This returns a client_form object. The migration changes can be found in “List all forms for a client” under data.*

Below are examples of responses:

json
{
    "object": "paginated_list",
    "data": [
        {
            "object": "client_form",
            "id": 37344,
            "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",
            "type": "requested",
            "client": 73212,
            "record": 87564,
            "name": "New starter form",
            "description": null,
            "instructions": null,
            "fields": [
                {
                    "id": "1",
                    "type": "section",
                    "label": "",
                    "fields": [
                        "2"
                    ]
                },
                {
                    "id": "2",
                    "type": "section",
                    "label": "Onboarding",
                    "fields": [
                        "3",
                        "4"
                    ]
                },
                {
                    "id": "3",
                    "type": "text",
                    "label": "Job title",
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": null
                },
                {
                    "id": "4",
                    "type": "radio",
                    "label": {
                        "value": "Contract type",
                        "options": [
                            "Full-time",
                            "Part-time"
                        ]
                    },
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": null
                }
            ],
            "version": 1,
            "created_at": "2022-10-11T13:41:38Z",
            "updated_at": "2022-10-11T13:41:38Z",
            "completed_at": null,
            "archived_at": null
        },
        {
            "object": "client_form",
            "id": 37523,
            "reference": "4fdb5ab5-f83e-4b52-926b-340e880bb030",
            "type": "internal",
            "client": 73212,
            "record": null,
            "name": "Onboarding checklist",
            "description": "Checklist for all new employees.",
            "instructions": null,
            "fields": [
                {
                    "id": "1",
                    "type": "section",
                    "label": "",
                    "fields": [
                        "2",
                        "3"
                    ]
                },
                {
                    "id": "2",
                    "type": "radio",
                    "label": {
                        "value": "Location",
                        "options": [
                            "Office",
                            "Remote",
                            "Hybrid"
                        ]
                    },
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": "Remote"
                },
                {
                    "id": "3",
                    "type": "radio",
                    "label": {
                        "value": "Department",
                        "options": [
                            "Sales",
                            "Marketing",
                            "Legal",
                            "Admin"
                        ]
                    },
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": "Admin"
                }
            ],
            "version": 2,
            "created_at": "2022-11-02T15:55:38Z",
            "updated_at": "2022-11-05T20:02:06Z",
            "completed_at": null,
            "archived_at": null
        }
    ],
    "total": 2,
    "count": 2,
    "limit": 100,
    "current_page": 1,
    "total_pages": 1,
    "links": null
}
json
{
    "object": "client_form",
    "data": [
        {
            "id": 37344,
            "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",
            "type": "requested",
            "client": 73212,
            "record": 87564,
            "name": "New starter form",
            "description": null,
            "instructions": null,
            "fields": [
                {
                    "id": "1",
                    "type": "section",
                    "label": "",
                    "fields": [
                        "2"
                    ]
                },
                {
                    "id": "2",
                    "type": "section",
                    "label": "Onboarding",
                    "fields": [
                        "3",
                        "4"
                    ]
                },
                {
                    "id": "3",
                    "type": "text",
                    "label": "Job title",
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": null
                },
                {
                    "id": "4",
                    "type": "radio",
                    "label": {
                        "value": "Contract type",
                        "options": [
                            "Full-time",
                            "Part-time"
                        ]
                    },
                    "validation": [
                        "required"
                    ],
                    "flag": false,
                    "value": null
                }
            ],
            "version": 1,
            "created_at": "2022-10-11T13:41:38Z",
            "updated_at": "2022-10-11T13:41:38Z",
            "completed_at": null,
            "archived_at": null
        }
    ],
}

INFO

📌 Please refer to Retrieve a form for a client for more information.

Get a PDF version of a form ​

WARNING

Please note that v1 simply opened the link to a pdf version of a form. v2 will initiate the download automatically.

INFO

📌 Please refer to Download a form for a client for more information.

Company Registration Number: SC511150 — Data Protection Registration Number: ZA136760
Policies:
Certified for all confidence profilesCyber Essentials Plus certificationNQA ISO 27001 UKAS certificationAWS Qualified SoftwareG2 High Performer badgeG2 Users Love Us badge