API docs by Redocly

Amiqus ID REST API (2.0)

Download OpenAPI specification:Download

Amiqus Engineering: developers@amiqus.co URL: https://developers.amiqus.co/aqid/api-reference.html

Amiqus ID API reference.

Changelog

Service Status

Check service status

The status endpoint can be used to perform an authenticated request to verify the access token is valid and that the service is operational.

Authorizations:
personal_tokenoauth

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/status \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "error": "Unauthenticated."
}

User Account

Retrieve user account

Retrieve details of the current user's account.

Access tokens are scoped to a single user account and team (if they are a member of more than one). This endpoint can be used to determine which user the access token was issued for.

To retrieve details of the user's role within their current team, refer to Retrieve team membership.

Authorizations:
personal_tokenoauth

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/me \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "user",
  • "id": 345789,
  • "name": "Bob Gale",
  • "email": "bob@example.com",
  • "is_verified": true,
  • "is_disabled": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update user account

Update the current user's account details.

When updating a user's email address, the change must be confirmed by the user via an email sent to their current email address. The updated email address won't be reflected in the response until the confirmation is complete.

It is not possible to update a user's password using the API.

Authorizations:
personal_tokenoauth
Request Body schema: application/json
non-empty
name
string

Full or partial name

The value is not formatted (e.g. title case), and appears as written.

email
string <email>

Unique user email address

Responses

Request samples

Content type
application/json
{
  • "name": "Robert Gale"
}

Response samples

Content type
application/json
{
  • "object": "user",
  • "id": 345789,
  • "name": "Robert Gale",
  • "email": "bob@example.com",
  • "is_verified": true,
  • "is_disabled": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List all my teams

List all teams the current user is a member of.

A user can be a member of multiple teams. To retrieve details of the team the access token is scoped to, refer to Retrieve current team.

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/me/teams?page=INTEGER_VALUE&limit=INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Your Team

Retrieve current team

Returns basic details of the current team.

Authorizations:
personal_tokenoauth

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/team \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "team",
  • "id": 88,
  • "identifier": "fusion-industries",
  • "uuid": "6b9c8323-4b54-4bb3-a1c8-68de534368a5",
  • "name": "Fusion Industries",
  • "contact": "fusion.support@example.com",
  • "telephone": null,
  • "tier": "standard_2021",
  • "logo": null,
  • "is_support_enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "archived_at": null
}

Update current team

Updates basic details of the current team.

Authorizations:
personal_tokenoauth
Request Body schema: application/json
non-empty
contact
string <email>
telephone
null or string

Responses

Request samples

Content type
application/json
{
  • "contact": "fusion@example.com"
}

Response samples

Content type
application/json
{
  • "object": "team",
  • "id": 88,
  • "identifier": "fusion-industries",
  • "uuid": "6b9c8323-4b54-4bb3-a1c8-68de534368a5",
  • "name": "Fusion Industries",
  • "contact": "fusion@example.com",
  • "telephone": null,
  • "tier": "standard_2021",
  • "logo": null,
  • "is_support_enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "archived_at": null
}

Retrieve team membership

Retrieve membership details for the user's current team.

To retrieve the user's basic details, refer to Retrieve user account.

Authorizations:
personal_tokenoauth

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/team/me \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "team_member",
  • "id": 121,
  • "name": "Lorraine Baines",
  • "email": "lorraine@example.com",
  • "role": "owner"
}

List all team members

List all team members of the current team.

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/team/members?page=INTEGER_VALUE&limit=INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

List all credit history

Return a list of credit usage history

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
sort_by
string
Value: "created_at"

Sort results by specified item. Results returned in created order by default.

order_by
string
Enum: "asc" "desc"

Order results in ascending or descending order. Results returned in ascending order by default.

expand
Array of strings
Items Value: "causer"

Expand the causer property to include details about the event that caused the credit history entry.

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/credits?page=INTEGER_VALUE&limit=INTEGER_VALUE&sort_by=STRING_VALUE&order_by=STRING_VALUE&expand=ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
Example
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Records

List all records

List all records.

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
sort_by
string
Enum: "client.name.first_name" "client.name.last_name" "created_at" "updated_at" "archived_at"

Sort results by client name or date. Results returned in created_at order by default

order_by
string
Enum: "asc" "desc"

Order results in ascending or descending order. Results returned in ascending order by default

expand
Array of strings
Items Value: "client"
status
string
Enum: "pending" "started" "complete" "incomplete" "waiting" "failed" "empty" "paused" "amendments" "reviewed"

Filter records by their current status.

Note: failed is deprecated.

visibility
string
Enum: "active" "archived"

Filter records by their current visibility. Both "active" and "archived" records are returned by default.

creator
integer
Deprecated

To filter records created by team member user ID.

This query parameter is deprecated and has been replaced by created_by.

created_by
integer

Filter records created by team member user ID

integer or boolean

Filter records assigned to team member user ID or use false to filter unassigned records only. Both assigned and unassigned records are returned by default.

client_visibility
string
Enum: "active" "archived"

Filter records by the visibility of their associated client. By default records are returned for both active and archived clients.

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/records?page=INTEGER_VALUE&limit=INTEGER_VALUE&sort_by=STRING_VALUE&order_by=STRING_VALUE&expand=ARRAY_VALUE&status=STRING_VALUE&visibility=STRING_VALUE&creator=INTEGER_VALUE&created_by=INTEGER_VALUE&assignee=QUERY_VALUE&client_visibility=STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Create a record

Create a record.

Authorizations:
personal_tokenoauth
Request Body schema: application/json
One of
client
required
integer

Unique client identifier.

required
Array of (Credit report (TransUnion (object) or Equifax (object))) or Criminal record (object) or Dummy (object) or Thorntons Onboarding (object) or HSCNI Access NI (object) or (Identity report (TransUnion (object) or Equifax (object))) or NHS ESR (object) or Photo ID (object) or Employment referencing (object) or Employment history (object) or Banking information (object) or Face capture (object) or Watchlist (object) or Document Request (object) or Document Transfer (object) or Form (object) (Record Steps) non-empty

Steps to be completed by the client.

required
string or boolean

Enable or disable a "New Request" notification to the client.

message
null or string <= 5000 characters

Include a message for client.

Message is shown to the client before they begin the first step. It is also included in an email notification, if sent.

reminder
boolean
Default: false

Enable or disable email reminders.

When enabled, the client is sent a reminder email every 2 days until all steps have been completed, the record expires or is archived.

Responses

Request samples

Content type
application/json
Example

A request with a single step containing a Photo ID check

{
  • "client": 7832,
  • "steps": [
    ],
  • "notification": "email"
}

Response samples

Content type
application/json
Example
{
  • "object": "record",
  • "id": 983434,
  • "status": "pending",
  • "perform_url": "https://id.amiqus.co/i/NzJXeGzUYAQxaF1G80NB",
  • "email": "marty@example.com",
  • "client": 7832,
  • "steps": [
    ],
  • "has_reminders": true,
  • "created_at": "2022-05-22T08:22:12Z",
  • "updated_at": "2022-05-22T08:22:12Z",
  • "expired_at": "2022-06-01T08:22:12Z",
  • "archived_at": null
}

Retrieve a record

Retrieve a record.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique record identifier.

query Parameters
expand
Array of strings
Items Value: "client"

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/records/%7Bid%7D?expand=ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "record",
  • "id": 983434,
  • "status": "pending",
  • "perform_url": "https://id.amiqus.co/i/0vz32B9CZpO1yLsKPdy9q",
  • "email": "marty@example.com",
  • "client": 73845,
  • "steps": [
    ],
  • "has_reminders": true,
  • "created_at": "2022-05-22T08:22:12Z",
  • "updated_at": "2022-05-22T08:22:12Z",
  • "expired_at": "2022-06-01T08:22:12Z",
  • "archived_at": null
}

Update a record

Update the details of a record.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique record identifier.

Request Body schema: application/json
required
non-empty
is_archived
boolean

Allows toggling of archived state

is_reviewed
boolean

Allows toggling of reviewed state

has_reminders
boolean

Allows toggling of reminder state

string or boolean

Allows for setting the date and time that the record will expire.

Responses

Request samples

Content type
application/json
{
  • "is_archived": true,
  • "is_reviewed": true,
  • "expired_at": true
}

Response samples

Content type
application/json
{
  • "object": "record",
  • "id": 983434,
  • "status": "pending",
  • "perform_url": "https://id.amiqus.co/i/0vz32B9CZpO1yLsKPdy9q",
  • "email": "marty@example.com",
  • "client": 73845,
  • "steps": [
    ],
  • "has_reminders": true,
  • "created_at": "2022-05-22T08:22:12Z",
  • "updated_at": "2022-05-22T08:22:12Z",
  • "expired_at": "2022-05-25T08:22:12Z",
  • "archived_at": "2023-09-15T13:03:11Z"
}

Archive a record Deprecated

Archive a record.

This operation is deprecated and will be removed in future versions. To archive a record, please refer to Update a record.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer
query Parameters
expand
Array of strings
Items Value: "client"

Responses

Request samples 

curl --request POST \
  --url 'https://id.amiqus.co/api/v2/records/%7Bid%7D/archive?expand=ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "record",
  • "id": 0,
  • "status": "pending",
  • "perform_url": "string",
  • "email": "user@example.com",
  • "client": {
    },
  • "steps": [
    ],
  • "has_reminders": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "expired_at": "2019-08-24T14:15:22Z",
  • "archived_at": null
}

Expire a record

Expire a record.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique record identifier.

query Parameters
expand
Array of strings
Items Value: "client"

Responses

Request samples 

curl --request POST \
  --url 'https://id.amiqus.co/api/v2/records/%7Bid%7D/expire?expand=ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "record",
  • "id": 0,
  • "status": "pending",
  • "perform_url": "string",
  • "email": "user@example.com",
  • "client": {
    },
  • "steps": [
    ],
  • "has_reminders": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "expired_at": "2019-08-24T14:15:22Z",
  • "archived_at": null
}

Download a record

Download a record.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/records/%7Bid%7D/download \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "message": "This action is unauthorized."
}

List all steps for a record

List all steps for a record.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
expand
Array of strings
Items Enum: "check" "form" "document"
Examples:
  • expand=check - Expand one step type
  • expand=check,form - Expand multiple step types

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/records/%7Bid%7D/steps?page=INTEGER_VALUE&limit=INTEGER_VALUE&expand=check' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 3,
  • "count": 3,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

List all documents for a record

List all documents for a record.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
expand
Array of strings
Items Value: "attachments"

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/records/%7Bid%7D/documents?page=INTEGER_VALUE&limit=INTEGER_VALUE&expand=ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
Example

A sent document requested to be returned, with it's completed returned document.

{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Record Assignees

List all assignees for a record

List all assignees for a record.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique record identifier.

query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/records/%7Bid%7D/assignees?page=INTEGER_VALUE&limit=INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Add assignees to a record

Add one or more assignees to a record, merging them with existing assignees.

Existing assignees to the record are not included in the response. Only added assignees to the record will be returned.

To replace assignees, refer to Replace assignees for a record.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique record identifier.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
type
required
string

The type of assignee to be assigned to the record.

Value: "team_member"
team_member
required
integer

The unique identifier of the team member to be assigned to the record.

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "object": "list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "has_more": false,
  • "url": "https://id.amiqus.co/api/v2/records/87249/assignees"
}

Replace assignees for a record

Replacing all existing assignees for a record.

Existing assignees to the record that are included in the request will be part of the updated assignees to the record but they will not be shown in the response. Only added assignees will be returned.

To add additional assignees, refer to Add assignees for a record.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique record identifier.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
type
required
string

The type of assignee to be assigned to the record.

Value: "team_member"
team_member
required
integer

The unique identifier of the team member to be assigned to the record.

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "object": "list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "has_more": false,
  • "url": "https://id.amiqus.co/api/v2/records/87249/assignees"
}

Delete assignees for a record

Remove all assignees from a record.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique record identifier.

Request Body schema: application/json
Schema not provided

Responses

Request samples 

curl --request DELETE \
  --url https://id.amiqus.co/api/v2/records/%7Bid%7D/assignees \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "error": "Unauthenticated."
}

Delete assignee for a record

Remove a single assignee from a record.

To list all of a record's assignees, see List all assignees for a record.

Authorizations:
personal_tokenoauth
path Parameters
recordId
required
integer

Unique record identifier.

assigneeId
required
integer

Unique assignee identifier.

Request Body schema: application/json
Schema not provided

Responses

Request samples 

curl --request DELETE \
  --url https://id.amiqus.co/api/v2/records/%7BrecordId%7D/assignees/%7BassigneeId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "error": "Unauthenticated."
}

Clients

List all clients

Returns a paginated list of clients.

To retrieve a client, refer to Retrieve a client.

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
search
string

Search for clients by name (first, middle and last), reference and organisation name. Search is case-insensitive and fuzzy.

status
string
Enum: "pending" "approved" "rejected"

Filter clients by their current status.

visibility
string
Enum: "active" "archived"

Filter clients by their visibility state. Both active and archived clients are returned by default.

assignee
integer

Filter records assigned to this team member's user ID.

reference
string

Filter users by reference.

This search is case-insensitive but is not fuzzy and will only return full matches.

sort_by
string
Enum: "name.first_name" "name.last_name" "created_at" "updated_at" "archived_at"

Sort results by name or date. Results returned in ID order by default

order_by
string
Enum: "asc" "desc"

Order results in ascending or descending order. Results returned in ascending order by default

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/clients?page=INTEGER_VALUE&limit=INTEGER_VALUE&search=STRING_VALUE&status=STRING_VALUE&visibility=STRING_VALUE&assignee=INTEGER_VALUE&reference=STRING_VALUE&sort_by=STRING_VALUE&order_by=STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 3,
  • "count": 3,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Create a client

Create a new client.

Authorizations:
personal_tokenoauth
Request Body schema: application/json
status
string
Enum: "pending" "approved" "rejected"

A status can be set to signify a decision has been made by a team member on the outcome of the client's checks.

required
object (Name)

The client's names.

Includes automatic compilations of the client's full name for display purposes.

email
required
string <email>

Client's contact email address.

landline
null or string

Client's landline telephone number.

mobile
null or string

Client's mobile telephone number.

dob
null or string <date>

Client's date of birth.

reference
null or string

An external reference or identifier to cross-reference with your system.

Responses

Request samples

Content type
application/json
{
  • "name": {
    },
  • "email": "marty@example.com"
}

Response samples

Content type
application/json
{
  • "object": "client",
  • "id": 73845,
  • "status": "pending",
  • "name": {
    },
  • "email": "marty@example.com",
  • "landline": null,
  • "mobile": null,
  • "dob": null,
  • "reference": null,
  • "national_insurance_number": "QQ123456C",
  • "is_deletable": true,
  • "created_at": "2022-05-21T14:15:22Z",
  • "updated_at": "2022-05-21T14:15:22Z",
  • "archived_at": null
}

Retrieve a client

Returns a single client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique client identifier

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/clients/%7Bid%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "client",
  • "id": 73845,
  • "status": "pending",
  • "name": {
    },
  • "email": "marty@example.com",
  • "landline": null,
  • "mobile": null,
  • "dob": null,
  • "reference": null,
  • "national_insurance_number": "QQ123456C",
  • "is_deletable": true,
  • "created_at": "2022-05-21T14:15:22Z",
  • "updated_at": "2022-05-21T14:15:22Z",
  • "archived_at": null
}

Update a client

Update the details of a client.

To add or update a client's address, refer to Replace an address for a client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique client identifier

Request Body schema: application/json
non-empty
status
string
Enum: "pending" "approved" "rejected"

A status can be set to signify a decision has been made by a team member on the outcome of the client's checks.

object (Name)

The client's names.

Includes automatic compilations of the client's full name for display purposes.

email
string <email>

Client's contact email address.

landline
null or string

Client's landline telephone number.

mobile
null or string

Client's mobile telephone number.

dob
null or string <date>

Client's date of birth.

reference
null or string

An external reference or identifier to cross-reference with your system.

Responses

Request samples

Content type
application/json

Update the client's email address.

{
  • "email": "martin.mcfly@example.com"
}

Response samples

Content type
application/json
{
  • "object": "client",
  • "id": 73845,
  • "status": null,
  • "name": {
    },
  • "email": "martin.mcfly@example.com",
  • "landline": null,
  • "mobile": null,
  • "dob": null,
  • "reference": null,
  • "national_insurance_number": "QQ123456C",
  • "is_deletable": true,
  • "created_at": "2022-05-21T14:15:22Z",
  • "updated_at": "2022-09-22T17:02:13Z",
  • "archived_at": null
}

Delete a client

Delete a client. Can be performed by Admin or Member users only. Clients with requests attached can only be deleted by Admin users.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique client identifier

Responses

Request samples 

curl --request DELETE \
  --url https://id.amiqus.co/api/v2/clients/%7Bid%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "message": "This action is unauthorized."
}

Retrieve address for a client

Retrieve address for a client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique client identifier.

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/clients/%7Bid%7D/address \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "address",
  • "unit": "3rd Floor",
  • "house_name": "Citypoint",
  • "house_number": "65",
  • "street_name": "Haymarket Terrace",
  • "second_street": null,
  • "district": null,
  • "city": "Edinburgh",
  • "province": null,
  • "postcode": "EH12 5HD",
  • "country": "GB"
}

Replace an address for a client

Replace address for a client.

Each country has its own field requirements. Any field can become required if the selected country demands it, most commonly postcode.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique client identifier.

Request Body schema: application/json
non-empty
unit
null or string

Unit, flat or apartment name or number.

house_name
null or string

House or building name.

house_number
null or string

House or building number.

street_name
null or string

First line of the street name.

second_street
null or string

Second line of the street name if applicable.

district
null or string

District, town, village, suburb or equivalent.

city
null or string

City name if applicable.

province
null or string

Province, county, municipality, township or equivalent.

postcode
null or string

Postcode, zip code or equivalent.

country
null or string
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "HR" "CU" "CW" "CY" "CZ" "CI" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "XK" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "AN" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "OM" "PK" "PS" "PW" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "CM" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "VC" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "YU" "ZM" "ZW"

ISO3601 alpha-2 country code.

Responses

Request samples

Content type
application/json
{
  • "unit": "3rd Floor",
  • "house_name": "Citypoint",
  • "house_number": "65",
  • "street_name": "Haymarket Terrace",
  • "city": "Edinburgh",
  • "postcode": "EH12 5HD",
  • "country": "GB"
}

Response samples

Content type
application/json
{
  • "object": "address",
  • "unit": "3rd Floor",
  • "house_name": "Citypoint",
  • "house_number": "65",
  • "street_name": "Haymarket Terrace",
  • "second_street": null,
  • "district": null,
  • "city": "Edinburgh",
  • "province": null,
  • "postcode": "EH12 5HD",
  • "country": "GB"
}

List all forms for a client

List all forms for a client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
expand
Array of strings
Items Enum: "client" "record"
type
string
Enum: "internal" "requested"

Filter by internal client forms (internal), or requested for completion by the client (requested). Includes both by default.

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/clients/%7Bid%7D/forms?page=INTEGER_VALUE&limit=INTEGER_VALUE&expand=ARRAY_VALUE&type=STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Retrieve a form for a client

Retrieve a form for a client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer
reference
required
string <uuid>

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/clients/%7Bid%7D/forms/%7Breference%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
Example

A form for completion by the client

{
  • "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": [
    ],
  • "version": 1,
  • "created_at": "2022-10-11T13:41:38Z",
  • "updated_at": "2022-10-11T13:41:38Z",
  • "completed_at": null,
  • "archived_at": null
}

Download a form for a client

Download a form for a client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer
reference
required
string <uuid>

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/clients/%7Bid%7D/forms/%7Breference%7D/download \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "message": "This action is unauthorized."
}

List all records for a client

List all records for a client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
expand
Array of strings
Items Value: "client"

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/clients/%7Bid%7D/records?page=INTEGER_VALUE&limit=INTEGER_VALUE&expand=ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

List all corrections for a client

Retrieve a paginated list of corrections for a client

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer
query Parameters
page
integer >= 1

Page number of items to return.

limit
integer [ 1 .. 100 ]

Number of items to return per page.

sort_by
string
Value: "created_at"

Sort corrections by creation date.

order_by
string
Enum: "asc" "desc"

Order results in ascending or descending order. Results returned in ascending order by default

expand
Array of strings
Items Enum: "client" "record"
status
string
Enum: "pending" "accepted" "rejected"

Filter corrections by status.

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/clients/%7Bid%7D/corrections?page=INTEGER_VALUE&limit=INTEGER_VALUE&sort_by=STRING_VALUE&order_by=STRING_VALUE&expand=ARRAY_VALUE&status=STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Update a correction for a client

Accept, reject and modify a name correction proposed by a client.

Authorizations:
personal_tokenoauth
path Parameters
clientId
required
integer

Unique client identifier.

correctionId
required
string

Unique client correction identifier.

Request Body schema: application/json
One of
status
required
string
Value: "accepted"
object non-empty

Responses

Request samples

Content type
application/json
Example

Accept the client correction as provided.

{
  • "status": "accepted"
}

Response samples

Content type
application/json
{
  • "object": "client_correction",
  • "id": 34234,
  • "client": 73823,
  • "record": 915732,
  • "status": "accepted",
  • "correction": {
    },
  • "created_at": "2022-05-22T11:08:31Z",
  • "updated_at": "2022-05-23T08:53:21Z"
}

Client Assignees

List all assignees for a client

Returns a paginated list of the client's assignees.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique client identifier.

query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/clients/%7Bid%7D/assignees?page=INTEGER_VALUE&limit=INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Add assignees to a client

Add one or more assignees to a client, merging them with existing assignees.

Existing assignees to the client are not included in the response. Only added assignees to the client will be returned.

To replace assignees, refer to Replace assignees for a client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique client identifier.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
type
required
string

The type of assignee to be assigned to the client.

Value: "team_member"
team_member
required
integer

The unique identifier of the team member to be assigned to the client.

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "object": "list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "has_more": false,
  • "url": "https://id.amiqus.co/api/v2/clients/4672/assignees"
}

Replace assignees for a client

Replace all existing assignees for a client.

Existing assignees to the client that are included in the request will be part of the updated assignees to the client but they will not be shown in the response. Only added assignees will be returned.

To add additional assignees without replacing existing, refer to Add assignees for a client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique client identifier.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
type
required
string

The type of assignee to be assigned to the client.

Value: "team_member"
team_member
required
integer

The unique identifier of the team member to be assigned to the client.

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "object": "list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "has_more": false,
  • "url": "https://id.amiqus.co/api/v2/clients/4672/assignees"
}

Delete assignees for a client

Remove all assignees from a client.

To delete a single client assignee, see Delete an assignee for a client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique client identifier.

Request Body schema: application/json
Schema not provided

Responses

Request samples 

curl --request DELETE \
  --url https://id.amiqus.co/api/v2/clients/%7Bid%7D/assignees \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "error": "Unauthenticated."
}

Delete an assignee for a client

Remove an assignee from a client.

To delete all client assignees, see Delete assignees for a client.

Authorizations:
personal_tokenoauth
path Parameters
clientId
required
integer

Unique client identifier.

assigneeId
required
integer

Unique assignee identifier.

Request Body schema: application/json
Schema not provided

Responses

Request samples 

curl --request DELETE \
  --url https://id.amiqus.co/api/v2/clients/%7BclientId%7D/assignees/%7BassigneeId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "error": "Unauthenticated."
}

Client Files

List all files for a client

List all files for a client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer
query Parameters
expand
Array of strings
Items Enum: "source" "created_by"
sort_by
string
Enum: "name" "created_at" "expires_at"

Sort results by file name, date of upload or file expiry date. Results returned in ID order by default.

order_by
string
Enum: "asc" "desc"

Order results in ascending or descending order. Results returned in ascending order by default.

source
string
Enum: "check" "client" "client_form" "form" "record_document"

Note: form is deprecated, use client_form instead

source_type
string
Enum: "photo_id" "reference" "banking_information" "employment_referencing" "requested" "sent" "returned"

Some sources can be filtered by type:

  • check:
    • photo_id
    • reference
    • banking_information
    • employment_referencing
  • record_document
    • requested, sent, returned

Note: to filter by source type, the source parameter must also be provided.

search
string

Search for client files by name. Search is case-insensitive and fuzzy.

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/clients/%7Bid%7D/files?expand=ARRAY_VALUE&sort_by=STRING_VALUE&order_by=STRING_VALUE&source=STRING_VALUE&source_type=STRING_VALUE&search=STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
Example

An internal file attached directly to the client.

{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Create a file for a client

Create a file for a client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer
Request Body schema: application/json
attachment
required
integer

The unique identifier of an attachment

To create an attachment, refer to the Create an attachment.

name
string (name) [ 1 .. 255 ]
expires_at
null or string <date-time> (expires_at)

The date and time an uploaded file expires.

Responses

Request samples

Content type
application/json
{
  • "attachment": 31782,
  • "name": "NDA-final",
  • "expires_at": "2025-01-01T23:59:59Z"
}

Response samples

Content type
application/json
{
  • "object": "client_file",
  • "id": 31788,
  • "type": "internal",
  • "source": {
    },
  • "name": "NDA-final",
  • "attachment": {
    },
  • "created_by": {
    },
  • "expires_at": "2025-01-01T23:59:59Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Download a file for a client

Download a file for a client.

Authorizations:
personal_tokenoauth
path Parameters
clientId
required
integer
fileId
required
integer

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/clients/%7BclientId%7D/files/%7BfileId%7D/download \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "error": "Unauthenticated."
}

Client Organisations

List all organisations for a client

Returns a paginated list of a client's organisation memberships. When an organisation is archived all clients associated with the organisation will be removed.

To retrieve organisations for the team, refer to List all organisations.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique client identifier

query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
sort_by
string
Enum: "name" "created_at" "updated_at" "archived_at"

Sort results by organisation name. Results returned in created order by default.

order_by
string
Enum: "asc" "desc"

Order results in ascending or descending order. Results returned in ascending order by default.

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/clients/%7Bid%7D/organisations?page=INTEGER_VALUE&limit=INTEGER_VALUE&sort_by=STRING_VALUE&order_by=STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Add organisations for a client

Add the client to one or more organisations, merging them with existing organisation memberships. Existing organisation memberships are not included in the response. Only added organisation memberships will be returned.

To replace organisations, refer to Replace organisations for a client.

To update an organisation's basic details, refer to Update an organisation.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique client identifier

Request Body schema: application/json
Array (non-empty)
integer

Unique organisation identifier

Responses

Request samples

Content type
application/json
[
  • 3970,
  • 4117
]

Response samples

Content type
application/json
Example

Membership to 4117 already existed before the request.

{
  • "object": "list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "has_more": false,
  • "url": "https://id.amiqus.co/api/v2/clients/73845/organisations"
}

Replace organisations for a client

Replaces a client's organisation memberships. Existing organisation memberships that are included in the request will be part of the updated organisation memberships, but they will not be shown in the response. Only added organisations will be returned.

To add additional organisations without replacing existing, refer to Add organisations for a client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique client identifier

Request Body schema: application/json
Array (non-empty)
integer

Unique organisation identifier

Responses

Request samples

Content type
application/json
[
  • 3970,
  • 4117
]

Response samples

Content type
application/json
{
  • "object": "list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "has_more": false,
  • "url": "https://id.amiqus.co/api/v2/clients/73845/organisations"
}

Delete organisations for a client

Delete all of a client's organisation memberships.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique client identifier

Responses

Request samples 

curl --request DELETE \
  --url https://id.amiqus.co/api/v2/clients/%7Bid%7D/organisations \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "error": "Unauthenticated."
}

Delete organisation for a client

Delete a single client organisation membership.

Authorizations:
personal_tokenoauth
path Parameters
clientId
required
integer

Unique client identifier

organisationId
required
integer

Unique organisation identifier

Responses

Request samples 

curl --request DELETE \
  --url https://id.amiqus.co/api/v2/clients/%7BclientId%7D/organisations/%7BorganisationId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "error": "Unauthenticated."
}

Cases

List all cases

List all cases.

Cases may not be enabled for all teams.

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
sort_by
string
Enum: "name" "reference" "client.name.first_name" "client.name.last_name" "created_at" "updated_at" "archived_at"

Sort results by name, reference, client name or date. Results returned in created_at order by default.

order_by
string
Enum: "asc" "desc"

Order results in ascending or descending order. Results returned in ascending order by default.

expand
Array of strings
Items Enum: "client" "items" "assignees"
status
string (Case Status)
Enum: "pending" "on_hold" "approved" "rejected"

Filter cases by their current status.

visibility
string
Enum: "active" "archived"

Filter cases by their current visibility. Both "active" and "archived" cases are returned by default.

created_by
integer

Filter cases created by team member user ID

integer or boolean

Filter cases assigned to a team member user ID

client
integer

Filter cases by associated client ID

client_visibility
string
Enum: "active" "archived"

Filter cases by the visibility of their associated client. By default cases are returned for both active and archived clients.

reference
string

Filter cases by reference

search
string

Search for cases by case name and client name (first, middle and last). Search is case-insensitive and fuzzy.

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/cases?page=INTEGER_VALUE&limit=INTEGER_VALUE&sort_by=STRING_VALUE&order_by=STRING_VALUE&expand=ARRAY_VALUE&status=STRING_VALUE&visibility=STRING_VALUE&created_by=INTEGER_VALUE&assigned_to=QUERY_VALUE&client=INTEGER_VALUE&client_visibility=STRING_VALUE&reference=STRING_VALUE&search=STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
Example
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Create a case

Create a case.

Cases may not be enabled for all teams.

Authorizations:
personal_tokenoauth
Request Body schema: application/json
client
required
integer

The unique client identifier.

name
required
string

The case name.

reference
string

The case reference.

Responses

Request samples

Content type
application/json
{
  • "client": 7832,
  • "name": "Full-time onboarding",
  • "reference": "AQFT123"
}

Response samples

Content type
application/json
{
  • "object": "case",
  • "id": 8723,
  • "name": "Full-time onboarding",
  • "reference": "AQFT123",
  • "status": "pending",
  • "client": 7832,
  • "items": null,
  • "assignees": null,
  • "created_at": "2022-05-22T08:22:12Z",
  • "updated_at": "2022-05-22T08:22:12Z",
  • "archived_at": null
}

Retrieve a case

Retrieve a case.

Cases may not be enabled for all teams.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

The unique case identifier.

query Parameters
expand
Array of strings
Items Enum: "client" "items" "assignees"

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/cases/%7Bid%7D?expand=ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
Example
{
  • "object": "case",
  • "id": 8723,
  • "name": "Full-time onboarding",
  • "reference": "AQFT123",
  • "status": "pending",
  • "client": 73845,
  • "items": [
    ],
  • "assignees": [
    ],
  • "created_at": "2022-05-22T08:22:12Z",
  • "updated_at": "2022-05-22T08:22:12Z",
  • "archived_at": null
}

Update a case

Update the details of a case.

Cases may not be enabled for all teams.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

The unique case identifier.

Request Body schema: application/json
non-empty
name
string

The case name.

reference
null or string

The case reference.

is_archived
boolean

Allows toggling of archived state.

Responses

Request samples

Content type
application/json
Example

Update the case name and reference.

{
  • "name": "Part-time onboarding",
  • "reference": "AQPT123"
}

Response samples

Content type
application/json
{
  • "object": "case",
  • "id": 8723,
  • "name": "Part-time onboarding",
  • "reference": "AQPT123",
  • "status": "pending",
  • "client": 7832,
  • "items": [
    ],
  • "assignees": [
    ],
  • "created_at": "2022-05-22T08:22:12Z",
  • "updated_at": "2022-05-22T08:22:12Z",
  • "archived_at": null
}

List all reviews for a case

Returns a paginated list of reviews for a single case.

Cases may not be enabled for all teams.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

The unique case identifier.

query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
expand
Array of strings
Items Value: "reviewed_by"

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/cases/%7Bid%7D/reviews?page=INTEGER_VALUE&limit=INTEGER_VALUE&expand=ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
Example
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Create a case review

Review a case and update its status

Cases may not be enabled for all teams.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

The unique case identifier.

Request Body schema: application/json
status
required
string (ClientCaseStatus)
Enum: "pending" "on_hold" "approved" "rejected"

The overall status of the case.

  • pending: Active, awaiting approval or rejection.
  • on_hold: Inactive, on hold.
  • approved: Completed and approved.
  • rejected: Completed and rejected.

Responses

Request samples

Content type
application/json
{
  • "status": "approved"
}

Response samples

Content type
application/json
{
  • "object": "case_review",
  • "id": 2698,
  • "reviewed_by": 7832,
  • "status": "approved",
  • "from_status": "pending",
  • "created_at": "2022-05-22T08:22:12Z",
  • "updated_at": "2022-05-22T08:22:12Z"
}

Case Items

List all case items

Returns a paginated list of all case items.

Cases may not be enabled for all teams.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

The unique case identifier.

query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
expand
Array of strings
Items Value: "entity"

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/cases/%7Bid%7D/items?page=INTEGER_VALUE&limit=INTEGER_VALUE&expand=ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
Example
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Update items for a case

Add one or more items to a case, merging them with existing items. Only newly added items are returned.

Cases may not be enabled for all teams.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

The unique case identifier.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
id
required
integer

The unique identifier of the item to be added to the case.

type
required
string
Value: "record"

The type of item to be added to the case.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "object": "list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "has_more": false,
  • "url": "https://id.amiqus.co/api/v2/cases/8723/items"
}

Case Assignees

List all assignees for a case

Returns a paginated list of the case assignees.

Cases may not be enabled for all teams.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique case identifier

query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/cases/%7Bid%7D/assignees?page=INTEGER_VALUE&limit=INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Steps

List all steps

List all steps available for use.

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/steps?page=INTEGER_VALUE&limit=INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 5,
  • "count": 5,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Validate steps

Validate steps and return costs.

Authorizations:
personal_tokenoauth
Request Body schema: application/json
required
Array of (Credit report (TransUnion (object) or Equifax (object))) or Criminal record (object) or Dummy (object) or Thorntons Onboarding (object) or HSCNI Access NI (object) or (Identity report (TransUnion (object) or Equifax (object))) or NHS ESR (object) or Photo ID (object) or Employment referencing (object) or Employment history (object) or Banking information (object) or Face capture (object) or Watchlist (object) or Document Request (object) or Document Transfer (object) or Form (object) (Record Steps) non-empty

Responses

Request samples

Content type
application/json
Example

Steps containing an identity check and a standard Photo ID check with passport and driving licence document types enabled.

{
  • "steps": [
    ]
}

Response samples

Content type
application/json
Example

Validated steps containing an identity check and a standard Photo ID check with passport and driving licence document types enabled.

{
  • "object": "validated_steps",
  • "steps": [
    ]
}

Teams

List all team members

List all team members.

Authorizations:
personal_tokenoauth
path Parameters
teamId
required
integer

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/teams/%7BteamId%7D/members \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Retrieve a team member

Returns the member of a team.

Authorizations:
personal_tokenoauth
path Parameters
teamId
required
integer
teamMemberId
required
integer

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/teams/%7BteamId%7D/members/%7BteamMemberId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "team_member",
  • "id": 121,
  • "name": "Lorraine Baines",
  • "email": "lorraine@example.com",
  • "role": "owner"
}

Organisations

List all organisations

Returns a paginated list of the team's organisations.

To retrieve a specific client's organisations, refer to List all organisations for a client.

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
sort_by
string
Enum: "name" "created_at" "updated_at" "archived_at"

Sort results by organisation name. Results returned in created order by default.

order_by
string
Enum: "asc" "desc"

Order results in ascending or descending order. Results returned in ascending order by default.

visibility
string
Enum: "active" "archived"

Filter organisations by their visibility state. Both active and archived organisations are returned by default.

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/organisations?page=INTEGER_VALUE&limit=INTEGER_VALUE&sort_by=STRING_VALUE&order_by=STRING_VALUE&visibility=STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Create an organisation

Create a new organisation.

Authorizations:
personal_tokenoauth
Request Body schema: application/json
name
required
string <= 255

Organisation or company name The value is not formatted (e.g. title case), and appears as written.

company_number
null or string <= 255

The company registration number or reference

jurisdiction
null or string
Enum: "ae_az" "us_al" "us_ak" "al" "us_az" "us_ar" "aw" "au" "bs" "bh" "bd" "bb" "by" "be" "bz" "bm" "bo" "br" "bg" "us_ca" "kh" "ca" "us_co" "us_ct" "hr" "cw" "cy" "us_de" "dk" "us_dc" "do" "ae_du" "fi" "us_fl" "fr" "gf" "us_ga" "de" "gi" "gr" "gl" "gp" "gg" "us_hi" "hk" "is" "us_id" "in" "us_in" "us_ia" "ir" "ie" "im" "il" "jm" "jp" "je" "us_ks" "us_ky" "lv" "li" "us_la" "lu" "us_me" "my" "mt" "mq" "us_md" "us_ma" "mu" "yt" "mx" "us_mi" "us_mn" "us_ms" "us_mo" "md" "us_mt" "me" "mm" "us_ne" "nl" "us_nv" "ca_nb" "us_nh" "us_nj" "us_nm" "us_ny" "nz" "ca_nl" "us_nc" "us_nd" "no" "ca_ns" "us_oh" "us_ok" "us_or" "pk" "pa" "us_pa" "pl" "ca_pe" "pr" "ca_qc" "us_ri" "ro" "rw" "re" "bl" "mf" "pm" "sg" "sk" "si" "za" "us_sc" "us_sd" "es" "se" "ch" "tj" "tz" "us_tn" "us_tx" "th" "to" "tn" "ug" "ua" "gb" "us_ut" "vu" "us_vt" "vn" "us_va" "us_wa" "us_wv" "us_wi" "us_wy"

The country code or region where the company is registered.

Required if company_number is provided.

Responses

Request samples

Content type
application/json
{
  • "name": "Probert Publishing",
  • "company_number": "SF12188",
  • "jurisdiction": "gb"
}

Response samples

Content type
application/json
{
  • "object": "organisation",
  • "id": 3970,
  • "name": "Probert Publishing",
  • "company_number": "SF12188",
  • "jurisdiction": "gb",
  • "created_at": "2022-03-15T21:43:16Z",
  • "updated_at": "2022-03-15T21:43:16Z",
  • "archived_at": null
}

Retrieve an organisation

Returns a single organisation.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique organisation identifier

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/organisations/%7Bid%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "organisation",
  • "id": 3970,
  • "name": "Probert Publishing",
  • "company_number": "SF12188",
  • "jurisdiction": "gb",
  • "created_at": "2022-03-15T21:43:16Z",
  • "updated_at": "2022-03-15T21:43:16Z",
  • "archived_at": null
}

Update an organisation

Update the details of an organisation.

To add clients to or remove clients from the organisation, refer to Update organisations for a client.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique organisation identifier

Request Body schema: application/json
name
required
string <= 255

Organisation or company name The value is not formatted (e.g. title case), and appears as written.

company_number
null or string <= 255

The company registration number or reference

jurisdiction
null or string
Enum: "ae_az" "us_al" "us_ak" "al" "us_az" "us_ar" "aw" "au" "bs" "bh" "bd" "bb" "by" "be" "bz" "bm" "bo" "br" "bg" "us_ca" "kh" "ca" "us_co" "us_ct" "hr" "cw" "cy" "us_de" "dk" "us_dc" "do" "ae_du" "fi" "us_fl" "fr" "gf" "us_ga" "de" "gi" "gr" "gl" "gp" "gg" "us_hi" "hk" "is" "us_id" "in" "us_in" "us_ia" "ir" "ie" "im" "il" "jm" "jp" "je" "us_ks" "us_ky" "lv" "li" "us_la" "lu" "us_me" "my" "mt" "mq" "us_md" "us_ma" "mu" "yt" "mx" "us_mi" "us_mn" "us_ms" "us_mo" "md" "us_mt" "me" "mm" "us_ne" "nl" "us_nv" "ca_nb" "us_nh" "us_nj" "us_nm" "us_ny" "nz" "ca_nl" "us_nc" "us_nd" "no" "ca_ns" "us_oh" "us_ok" "us_or" "pk" "pa" "us_pa" "pl" "ca_pe" "pr" "ca_qc" "us_ri" "ro" "rw" "re" "bl" "mf" "pm" "sg" "sk" "si" "za" "us_sc" "us_sd" "es" "se" "ch" "tj" "tz" "us_tn" "us_tx" "th" "to" "tn" "ug" "ua" "gb" "us_ut" "vu" "us_vt" "vn" "us_va" "us_wa" "us_wv" "us_wi" "us_wy"

The country code or region where the company is registered.

Required if company_number is provided.

Responses

Request samples

Content type
application/json
{
  • "name": "Probert Publishing Co"
}

Response samples

Content type
application/json
{
  • "object": "organisation",
  • "id": 3970,
  • "name": "Probert Publishing Co",
  • "company_number": "SF12188",
  • "jurisdiction": "gb",
  • "created_at": "2022-03-15T21:43:16Z",
  • "updated_at": "2022-05-21T09:11:54Z",
  • "archived_at": null
}

Documents

List all documents

List all library documents.

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
enabled
boolean
expand
Array of strings
Items Value: "attachment"

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/documents?page=INTEGER_VALUE&limit=INTEGER_VALUE&enabled=BOOLEAN_VALUE&expand=ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
Example

A single document with attachment expanded.

{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Templates

List all email templates

List all email templates.

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
enabled
boolean

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/templates/emails?page=INTEGER_VALUE&limit=INTEGER_VALUE&enabled=BOOLEAN_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

List all document templates

List all document templates.

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
enabled
boolean

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/templates/documents?page=INTEGER_VALUE&limit=INTEGER_VALUE&enabled=BOOLEAN_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

List all record templates

List all record templates returns a paginated list of record templates associated with the team.

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
enabled
boolean

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/templates/records?page=INTEGER_VALUE&limit=INTEGER_VALUE&enabled=BOOLEAN_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Webhooks

List all webhooks

Returns a paginated list of webhooks.

To retrieve a webhook, refer to Retrieve a webhook.

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
enabled
boolean

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/webhooks?page=INTEGER_VALUE&limit=INTEGER_VALUE&enabled=BOOLEAN_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 2,
  • "count": 2,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Create a webhook

Create a webhook.

Authorizations:
personal_tokenoauth
Request Body schema: application/json
url
required
string

The webhook delivery url.

events
required
Array of strings (WebhookSubscribeEvents) non-empty unique
Items Enum: "*" "client.*" "form.*" "record.*" "client.archived" "client.created" "client.deleted" "client.organisations" "client.record" "client.status" "client.unarchived" "client.updated" "form.attached" "form.deleted" "form.modified" "form.sent" "form.submitted" "form.updated" "record.bounced" "record.created" "record.finished" "record.reviewed" "record.unreviewed" "record.updated"

The event or events this webhook is subscribed to. Supports wildcards; * all events, client.* all client events, etc.

is_enabled
boolean
Default: true

Whether or not the webhook is currently enabled.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "object": "webhook",
  • "id": 2154,
  • "uuid": "e4085749-1c11-4ac8-9361-df7f33c37ecb",
  • "url": "https://example.org/incoming/webhooks/amiqus",
  • "secret": "58585568aa4dc44c733bc244495fc1f2de3c2d2f56287c265274ab806f74bb34",
  • "events": [
    ],
  • "is_enabled": true,
  • "created_at": "2022-08-24T11:26:22Z",
  • "updated_at": "2022-08-24T11:26:22Z"
}

Retrieve a webhook

Retrieve a webhook.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique webhook identifier.

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/webhooks/%7Bid%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "webhook",
  • "id": 2154,
  • "uuid": "e4085749-1c11-4ac8-9361-df7f33c37ecb",
  • "url": "https://example.org/incoming/webhooks/amiqus",
  • "secret": "58585568aa4dc44c733bc244495fc1f2de3c2d2f56287c265274ab806f74bb34",
  • "events": [
    ],
  • "is_enabled": true,
  • "created_at": "2022-08-24T11:26:22Z",
  • "updated_at": "2022-08-24T11:26:22Z"
}

Update a webhook

Update a webhook.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique webhook identifier.

Request Body schema: application/json
url
string

The webhook delivery url.

events
Array of strings (WebhookSubscribeEvents) non-empty unique
Items Enum: "*" "client.*" "form.*" "record.*" "client.archived" "client.created" "client.deleted" "client.organisations" "client.record" "client.status" "client.unarchived" "client.updated" "form.attached" "form.deleted" "form.modified" "form.sent" "form.submitted" "form.updated" "record.bounced" "record.created" "record.finished" "record.reviewed" "record.unreviewed" "record.updated"

The event or events this webhook is subscribed to. Supports wildcards; * all events, client.* all client events, etc.

is_enabled
boolean

Whether or not the webhook is currently enabled.

Responses

Request samples

Content type
application/json
Example

Update both the URL and subscribed events.

{}

Response samples

Content type
application/json
{
  • "object": "webhook",
  • "id": 2154,
  • "uuid": "e4085749-1c11-4ac8-9361-df7f33c37ecb",
  • "url": "https://example.org/incoming/webhooks/amiqus",
  • "secret": "58585568aa4dc44c733bc244495fc1f2de3c2d2f56287c265274ab806f74bb34",
  • "events": [
    ],
  • "is_enabled": true,
  • "created_at": "2022-08-24T11:26:22Z",
  • "updated_at": "2022-08-24T11:26:22Z"
}

Delete a webhook

Delete a webhook.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique webhook identifier.

Responses

Request samples 

curl --request DELETE \
  --url https://id.amiqus.co/api/v2/webhooks/%7Bid%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "message": "This action is unauthorized."
}

List all deliveries for a webhook

List all deliveries for a webhook.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

Unique webhook identifier.

query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/webhooks/%7Bid%7D/deliveries?page=INTEGER_VALUE&limit=INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json

Example of a successful delivery for a ping event.

{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Forms

List all forms

List all forms.

Authorizations:
personal_tokenoauth
query Parameters
page
integer >= 1
limit
integer [ 1 .. 100 ]
enabled
boolean

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/forms?page=INTEGER_VALUE&limit=INTEGER_VALUE&enabled=BOOLEAN_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "paginated_list",
  • "data": [
    ],
  • "total": 1,
  • "count": 1,
  • "limit": 100,
  • "current_page": 1,
  • "total_pages": 1,
  • "links": null
}

Create a form

Create a form.

Authorizations:
personal_tokenoauth
Request Body schema: application/json
name
required
string <= 255 characters
description
null or string <= 255 characters
null or TipTap Document (object)
required
Array of Section (object) or Heading (object) or Paragraph (object) or Short Answer (object) or Long Answer (object) or Single Choice (object) or Multiple Choice (object) or (Document (Manual (object) or Template (object))) (BuilderFields) >= 2 items

The first field must always be a Section. Any Fields not present in a Section are omitted.

is_enabled
boolean
Default: true

Responses

Request samples

Content type
application/json
Example

A simple form with two required fields inside a section.

{
  • "name": "New starter form",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "object": "form_template",
  • "id": 45533,
  • "reference": "9b81f60f-2165-4e2c-b748-6c3071053e66",
  • "name": "New starter form",
  • "description": null,
  • "instructions": null,
  • "fields": [
    ],
  • "version": 4,
  • "is_enabled": true,
  • "created_at": "2022-08-24T11:26:22Z",
  • "updated_at": "2022-08-24T11:26:22Z",
  • "archived_at": null
}

Retrieve a form

Retrieve a form.

Authorizations:
personal_tokenoauth
path Parameters
reference
required
string <uuid>

Responses

Request samples 

curl --request GET \
  --url https://id.amiqus.co/api/v2/forms/%7Breference%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "form_template",
  • "id": 45533,
  • "reference": "9b81f60f-2165-4e2c-b748-6c3071053e66",
  • "name": "New starter form",
  • "description": null,
  • "instructions": null,
  • "fields": [
    ],
  • "version": 4,
  • "is_enabled": true,
  • "created_at": "2022-08-24T11:26:22Z",
  • "updated_at": "2022-08-24T11:26:22Z",
  • "archived_at": null
}

Update a form

Update a form.

Authorizations:
personal_tokenoauth
path Parameters
reference
required
string <uuid>
Request Body schema: application/json
non-empty
name
string <= 255 characters
description
null or string <= 255 characters
null or TipTap Document (object)
Array of Section (object) or Heading (object) or Paragraph (object) or Short Answer (object) or Long Answer (object) or Single Choice (object) or Multiple Choice (object) or (Document (Manual (object) or Template (object))) (BuilderFields) >= 2 items

The first field must always be a Section. Any Fields not present in a Section are omitted.

is_enabled
boolean

Responses

Request samples

Content type
application/json
Example

Update the "New starter form" adding a new multple choice answer.

{
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "object": "form_template",
  • "id": 45533,
  • "reference": "9b81f60f-2165-4e2c-b748-6c3071053e66",
  • "name": "New starter form",
  • "description": null,
  • "instructions": null,
  • "fields": [
    ],
  • "version": 5,
  • "is_enabled": true,
  • "created_at": "2022-08-24T11:26:22Z",
  • "updated_at": "2022-09-12T09:06:45Z",
  • "archived_at": null
}

Delete a form

Delete a form.

Authorizations:
personal_tokenoauth
path Parameters
reference
required
string <uuid>

Responses

Request samples 

curl --request DELETE \
  --url https://id.amiqus.co/api/v2/forms/%7Breference%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "message": "This action is unauthorized."
}

Attachments

Create an attachment

Create an attachment.

Authorizations:
personal_tokenoauth
Request Body schema: multipart/form-data
attachment
required
string <binary>

Supported file types: pdf, docx, doc, xlsx, xls, csv, txt, jpg, png, tiff, zip.

File size limit: 100MB.

Responses

Request samples 

curl --request POST \
  --url https://id.amiqus.co/api/v2/attachments \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: multipart/form-data' \
  --form attachment=string

Response samples

Content type
application/json
{
  • "object": "attachment",
  • "id": 31782,
  • "name": "14592310-706e-4bae-9171-83db2fa9d0fb.pdf",
  • "original": "NDA.pdf",
  • "type": "application/pdf",
  • "size": 16053,
  • "av_status": "clean",
  • "created_at": "2023-01-13T11:54:24Z",
  • "updated_at": "2023-01-13T11:54:24Z"
}

Delete an attachment

Delete an attachment

Only unassigned attachment can be deleted.

Authorizations:
personal_tokenoauth
path Parameters
id
required
integer

The unique attachment identifier.

Responses

Request samples 

curl --request DELETE \
  --url https://id.amiqus.co/api/v2/attachments/%7Bid%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "message": "This action is unauthorized."
}

Other Resources

Create an SDK token

Create an SDK token.

Authorizations:
personal_tokenoauth
Request Body schema: application/json
record_id
required
integer

The SDK Token is scoped for this individual Record only.

Responses

Request samples

Content type
application/json
{
  • "record_id": 44568
}

Response samples

Content type
application/json
{
  • "object": "sdk_token",
  • "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjQ5OTEzNzYwMCwiZXhwIjo0OTkxMzc2NjAsIm1hcnR5IjoiU291bmRzIHByZXR0eSBoZWF2eS4iLCJkb2MiOiJXZWlnaHQgaGFzIG5vdGhpbmcgdG8gZG8gd2l0aCBpdC4iLCLwn5GLIjoiVGhpcyBpcyBub3QgYSB2YWxpZCBTREsgVG9rZW4uIn0.j2jAeX_MpagkS7qvBjF9uYYIawP_uvEPqnftEW9wDe8"
}

Aggregates

Case status

Get an aggregate of case statuses.

Cases may not be enabled for all teams.

Authorizations:
personal_tokenoauth
query Parameters
integer or false (boolean)

Filter cases assigned to a team member ID

start_date
string <date-time>
Example: start_date=2024-01-02T12:00:00Z

Filter case statuses updated on or after a given date

end_date
string <date-time>
Example: end_date=2024-03-21T14:00:00Z

Filter case statuses updated on or before a given date

visibility
string
Enum: "active" "archived"

Filter cases by their current visibility. Both "active" and "archived" cases are returned by default.

Responses

Request samples 

curl --request GET \
  --url 'https://id.amiqus.co/api/v2/aggregates/case-status?assigned_to=QUERY_VALUE&start_date=2024-01-02T12%3A00%3A00Z&end_date=2024-03-21T14%3A00%3A00Z&visibility=STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "object": "case_status_aggregate",
  • "aggregates": [
    ]
}
Back to top