Amiqus ID REST API (2.0)
Download OpenAPI specification:Download
Amiqus ID API reference.
🚧 Please note this documentation is beta and is subject to change without notice.
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:
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/status \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 401
{- "error": "Unauthenticated."
}
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:
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/me \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
{- "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:
Request Body schema: application/json
non-emptyname | string Full or partial name The value is not formatted (e.g. title case), and appears as written. |
string <email> Unique user email address |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
{- "name": "Robert Gale"
}
Response samples
- 200
- 401
- 422
{- "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:
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/me/teams?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
{- "object": "paginated_list",
- "data": [
- {
- "object": "team",
- "id": 88,
- "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
}
], - "total": 1,
- "count": 1,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Retrieve current team
Returns basic details of the current team.
Authorizations:
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/team \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
{- "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:
Request Body schema: application/json
non-emptycontact | string <email> |
telephone | null or string |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
{- "contact": "fusion@example.com"
}
Response samples
- 200
{- "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:
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/team/me \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
{- "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:
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/team/members?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
{- "object": "paginated_list",
- "data": [
- {
- "object": "team_member",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "role": "owner"
}, - {
- "object": "team_member",
- "id": 472,
- "name": "Dennis Jones",
- "email": "dennis@example.com",
- "role": "member"
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
List all records
List all records.
Authorizations:
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
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 |
creator | integer Filter records created by team member user ID |
assignee | integer Filter records assigned to team member user ID |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/records?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&expand=SOME_ARRAY_VALUE&status=SOME_STRING_VALUE&creator=SOME_INTEGER_VALUE&assignee=SOME_INTEGER_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
{- "object": "paginated_list",
- "data": [
- {
- "object": "record",
- "id": 983434,
- "status": "pending",
- "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
}
], - "total": 1,
- "count": 1,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Create a record
Create a record.
Authorizations:
Request Body schema: application/json
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 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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
A request with a single step containing a Photo ID check
{- "client": 7832,
- "steps": [
- {
- "type": "check.photo_id",
- "preferences": {
- "report_type": "standard",
- "face": true,
- "docs": [
- "passport",
- "driving_licence"
]
}
}
], - "notification": "email"
}
Response samples
- 201
- 401
- 422
{- "object": "record",
- "id": 983434,
- "status": "pending",
- "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
}
Retrieve a record
Retrieve a record.
Authorizations:
path Parameters
id required | integer Unique record identifier. |
query Parameters
expand | Array of strings Items Value: "client" |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/records/%7Bid%7D?expand=SOME_ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 404
{- "object": "record",
- "id": 983434,
- "status": "pending",
- "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
}
Update a record
Update the details of a record.
To mark a record as expired, refer to Expire a record.
Authorizations:
path Parameters
id required | integer Unique record identifier. |
Request Body schema: application/json
non-emptyis_archived | boolean Allows toggling of archived state |
is_reviewed | boolean Allows toggling of reviewed state |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
{- "is_archived": true
}
Response samples
- 200
- 401
- 404
- 422
{- "object": "record",
- "id": 983434,
- "status": "pending",
- "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": "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:
path Parameters
id required | integer |
query Parameters
expand | Array of strings Items Value: "client" |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request POST \ --url 'https://id.amiqus.co/api/v2/records/%7Bid%7D/archive?expand=SOME_ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
{- "object": "record",
- "id": 0,
- "status": "pending",
- "perform_url": "string",
- "email": "user@example.com",
- "client": {
- "object": "client",
- "id": 0,
- "status": null,
- "name": {
- "object": "name",
- "title": "miss",
- "other_title": null,
- "first_name": "string",
- "middle_name": null,
- "last_name": "string",
- "name": "string",
- "full_name": "string",
- "complete_name": "string"
}, - "email": "user@example.com",
- "landline": null,
- "mobile": null,
- "dob": null,
- "reference": null,
- "is_deletable": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "archived_at": null
}, - "steps": [
- {
- "object": "step",
- "id": 0,
- "type": "check.credit",
- "check": {
- "object": "check",
- "id": 0,
- "type": "string",
- "record": 0,
- "status": "pending",
- "allow_replay": true,
- "allow_cancel": true,
- "requires_consent": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "cost": 0,
- "completed_at": null
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "archived_at": null
}
Expire a record
Expire a record.
Authorizations:
path Parameters
id required | integer Unique record identifier. |
query Parameters
expand | Array of strings Items Value: "client" |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request POST \ --url 'https://id.amiqus.co/api/v2/records/%7Bid%7D/expire?expand=SOME_ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 404
- 422
{- "object": "record",
- "id": 0,
- "status": "pending",
- "perform_url": "string",
- "email": "user@example.com",
- "client": {
- "object": "client",
- "id": 0,
- "status": null,
- "name": {
- "object": "name",
- "title": "miss",
- "other_title": null,
- "first_name": "string",
- "middle_name": null,
- "last_name": "string",
- "name": "string",
- "full_name": "string",
- "complete_name": "string"
}, - "email": "user@example.com",
- "landline": null,
- "mobile": null,
- "dob": null,
- "reference": null,
- "is_deletable": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "archived_at": null
}, - "steps": [
- {
- "object": "step",
- "id": 0,
- "type": "check.credit",
- "check": {
- "object": "check",
- "id": 0,
- "type": "string",
- "record": 0,
- "status": "pending",
- "allow_replay": true,
- "allow_cancel": true,
- "requires_consent": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "cost": 0,
- "completed_at": null
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "archived_at": null
}
Download a record
Download a record.
Authorizations:
path Parameters
id required | integer |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/records/%7Bid%7D/download \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
List all steps for a record
List all steps for a record.
Authorizations:
path Parameters
id required | integer |
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
expand | Array of strings Items Enum: "check" "form" "document" Examples:
|
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/records/%7Bid%7D/steps?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&expand=SOME_ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
{- "object": "paginated_list",
- "data": [
- {
- "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
}
], - "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:
path Parameters
id required | integer |
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
expand | Array of strings Items Value: "attachments" |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/records/%7Bid%7D/documents?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&expand=SOME_ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
A sent document requested to be returned, with it's completed returned document.
{- "object": "paginated_list",
- "data": [
- {
- "object": "record_document",
- "id": 3245,
- "type": "sent",
- "name": "3e337df9-872a-4753-b86a-87cb535ee16d.pdf",
- "status": "complete",
- "config": {
- "require_return": true,
- "require_confirmation": false,
- "instructions": "Non-disclosure agreement",
- "return_message": "Please sign and return the NDA."
}, - "source": {
- "type": "record",
- "id": 456884
}, - "attachments": [
- {
- "object": "attachment",
- "id": 1267,
- "name": "1d420ac7-a87a-444a-936b-dc29991ab8ed.pdf",
- "original": "NDA-final.pdf",
- "type": "application/pdf",
- "size": 74590,
- "av_status": "clean",
- "created_at": "2022-08-24T14:15:22Z",
- "updated_at": "2022-08-24T14:15:22Z"
}
], - "created_at": "2022-08-24T14:15:22Z",
- "updated_at": "2022-08-24T14:15:22Z",
- "completed_at": "2022-08-25T11:02:13Z"
}, - {
- "object": "record_document",
- "id": 3389,
- "type": "returned",
- "name": "35adbb44-be59-450c-bc41-fb32bded8e86.pdf",
- "status": "complete",
- "config": null,
- "source": {
- "type": "record_document",
- "id": 3245
}, - "attachments": [
- {
- "object": "attachment",
- "id": 1484,
- "name": "35adbb44-be59-450c-bc41-fb32bded8e86.pdf",
- "original": "NDA-final (signed).pdf",
- "type": "application/pdf",
- "size": 78448,
- "av_status": "clean",
- "created_at": "2022-08-25T11:02:13Z",
- "updated_at": "2022-08-25T11:02:13Z"
}
], - "created_at": "2022-08-24T14:15:22Z",
- "updated_at": "2022-08-25T11:02:13Z",
- "completed_at": "2022-08-25T11:02:13Z"
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
List all assignees for a record
List all assignees for a record.
Authorizations:
path Parameters
id required | integer Unique record identifier. |
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/records/%7Bid%7D/assignees?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 404
{- "object": "paginated_list",
- "data": [
- {
- "object": "assignee",
- "id": 34535,
- "type": "user",
- "user": {
- "object": "user",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - {
- "object": "assignee",
- "id": 34538,
- "type": "user",
- "user": {
- "object": "user",
- "id": 472,
- "name": "Dennis Jones",
- "email": "dennis@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-25T11:11:07Z",
- "updated_at": "2019-08-25T11:11:07Z"
}
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Set assignees for a record
Set the assignees for a record according to the exact values provided in the request, overwriting any existing assignees. To add additional assignees, refer to Update assignees for a record.
Authorizations:
path Parameters
id required | integer Unique record identifier. |
Request Body schema: application/json
type required | string Value: "user" The type of assignee to be assigned to the record. |
user required | integer The unique identifier of the user to be assigned to the record. |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
[- {
- "type": "user",
- "user": 121
}, - {
- "type": "user",
- "user": 472
}
]
Response samples
- 201
- 401
- 404
- 422
{- "object": "paginated_list",
- "data": [
- {
- "object": "assignee",
- "id": 34535,
- "type": "user",
- "user": {
- "object": "user",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - {
- "object": "assignee",
- "id": 34538,
- "type": "user",
- "user": {
- "object": "user",
- "id": 472,
- "name": "Dennis Jones",
- "email": "dennis@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-25T11:11:07Z",
- "updated_at": "2019-08-25T11:11:07Z"
}
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Update assignees for a record
Add one or more assignees to a record, merging them with existing assignees.
Authorizations:
path Parameters
id required | integer Unique record identifier. |
Request Body schema: application/json
type required | string Value: "user" The type of assignee to be assigned to the record. |
user required | integer The unique identifier of the user to be assigned to the record. |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
[- {
- "type": "user",
- "user": 523
}
]
Response samples
- 200
- 201
- 401
- 404
- 422
{- "object": "paginated_list",
- "data": [
- {
- "object": "assignee",
- "id": 34535,
- "type": "user",
- "user": {
- "object": "user",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - {
- "object": "assignee",
- "id": 34538,
- "type": "user",
- "user": {
- "object": "user",
- "id": 472,
- "name": "Dennis Jones",
- "email": "dennis@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-25T11:11:07Z",
- "updated_at": "2019-08-25T11:11:07Z"
}
}, - {
- "object": "assignee",
- "id": 34541,
- "type": "user",
- "user": {
- "object": "user",
- "id": 523,
- "name": "Clara Clayton",
- "email": "clara@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-25T13:54:32Z",
- "updated_at": "2019-08-25T13:54:32Z"
}
}
], - "total": 3,
- "count": 3,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Delete assignees for a record
Remove all assignees from a record.
Authorizations:
path Parameters
id required | integer Unique record identifier. |
Request Body schema: application/json
Schema not providedResponses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request DELETE \ --url https://id.amiqus.co/api/v2/records/%7Bid%7D/assignees \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ --header 'content-type: application/json'
Response samples
- 401
- 404
{- "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:
path Parameters
recordId required | integer Unique record identifier. |
assigneeId required | integer Unique assignee identifier. |
Request Body schema: application/json
Schema not providedResponses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request DELETE \ --url https://id.amiqus.co/api/v2/records/%7BrecordId%7D/assignees/%7BassigneeId%7D \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ --header 'content-type: application/json'
Response samples
- 401
- 404
{- "error": "Unauthenticated."
}
List all clients
Returns a paginated list of clients.
To retrieve a client, refer to Retrieve a client.
Authorizations:
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/clients?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
{- "object": "paginated_list",
- "data": [
- {
- "object": "client",
- "id": 73823,
- "status": "pending",
- "name": {
- "object": "name",
- "title": "mr",
- "other_title": null,
- "first_name": "Martin",
- "middle_name": "Seamus",
- "last_name": "McFly",
- "name": "Martin McFly",
- "full_name": "Martin Seamus McFly",
- "complete_name": "Mr Martin Seamus McFly"
}, - "email": "marty@example.com",
- "landline": null,
- "mobile": null,
- "dob": "1968-06-12",
- "reference": null,
- "is_deletable": true,
- "created_at": "2022-05-21T14:15:22Z",
- "updated_at": "2022-05-21T14:15:22Z",
- "archived_at": null
}, - {
- "object": "client",
- "id": 73841,
- "status": null,
- "name": {
- "object": "name",
- "title": "miss",
- "other_title": null,
- "first_name": "Jennifer",
- "middle_name": "Jane",
- "last_name": "Parker",
- "name": "Jennifer Parker",
- "full_name": "Jennifer Jane Parker",
- "complete_name": "Miss Jennifer Jane Parker"
}, - "email": "jennifer@example.com",
- "landline": null,
- "mobile": null,
- "dob": "1967-10-29",
- "reference": null,
- "is_deletable": true,
- "created_at": "2022-05-21T14:22:01Z",
- "updated_at": "2022-05-21T14:22:01Z",
- "archived_at": null
}, - {
- "object": "client",
- "id": 76219,
- "status": "approved",
- "name": {
- "object": "name",
- "title": "dr",
- "other_title": null,
- "first_name": "Emmett",
- "middle_name": "Lathrop",
- "last_name": "Brown",
- "name": "Emmett Brown",
- "full_name": "Emmett Lathrop Brown",
- "complete_name": "Dr Emmett Lathrop Brown"
}, - "email": "doc@example.com",
- "landline": null,
- "mobile": null,
- "dob": null,
- "reference": null,
- "is_deletable": true,
- "created_at": "2022-05-21T14:29:59Z",
- "updated_at": "2022-05-21T14:29:59Z",
- "archived_at": null
}
], - "total": 3,
- "count": 3,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Create a client
Create a new client.
Authorizations:
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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
{- "name": {
- "title": "mr",
- "first_name": "Martin",
- "middle_name": "Seamus",
- "last_name": "McFly"
}, - "email": "marty@example.com"
}
Response samples
- 201
- 401
- 422
{- "object": "client",
- "id": 73845,
- "status": "pending",
- "name": {
- "object": "name",
- "title": "mr",
- "other_title": null,
- "first_name": "Martin",
- "middle_name": "Seamus",
- "last_name": "McFly",
- "name": "Martin McFly",
- "full_name": "Martin Seamus McFly",
- "complete_name": "Mr Martin Seamus McFly"
}, - "email": "marty@example.com",
- "landline": null,
- "mobile": null,
- "dob": null,
- "reference": null,
- "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:
path Parameters
id required | integer Unique client identifier |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/clients/%7Bid%7D \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 404
{- "object": "client",
- "id": 73845,
- "status": "pending",
- "name": {
- "object": "name",
- "title": "mr",
- "other_title": null,
- "first_name": "Martin",
- "middle_name": "Seamus",
- "last_name": "McFly",
- "name": "Martin McFly",
- "full_name": "Martin Seamus McFly",
- "complete_name": "Mr Martin Seamus McFly"
}, - "email": "marty@example.com",
- "landline": null,
- "mobile": null,
- "dob": null,
- "reference": null,
- "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:
path Parameters
id required | integer Unique client identifier |
Request Body schema: application/json
non-emptystatus | 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. | |
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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
Update the client's email address.
{- "email": "martin.mcfly@example.com"
}
Response samples
- 200
- 401
- 404
- 422
{- "object": "client",
- "id": 73845,
- "status": null,
- "name": {
- "object": "name",
- "title": "mr",
- "other_title": null,
- "first_name": "Martin",
- "middle_name": "Seamus",
- "last_name": "McFly",
- "name": "Martin McFly",
- "full_name": "Martin Seamus McFly",
- "complete_name": "Mr Martin Seamus McFly"
}, - "email": "martin.mcfly@example.com",
- "landline": null,
- "mobile": null,
- "dob": null,
- "reference": null,
- "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:
path Parameters
id required | integer Unique client identifier |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request DELETE \ --url https://id.amiqus.co/api/v2/clients/%7Bid%7D \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Retrieve address for a client
Retrieve address for a client.
Authorizations:
path Parameters
id required | integer Unique client identifier. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/clients/%7Bid%7D/address \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 404
{- "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:
path Parameters
id required | integer Unique client identifier. |
Request Body schema: application/json
non-emptyunit | 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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
{- "unit": "3rd Floor",
- "house_name": "Citypoint",
- "house_number": "65",
- "street_name": "Haymarket Terrace",
- "city": "Edinburgh",
- "postcode": "EH12 5HD",
- "country": "GB"
}
Response samples
- 200
- 401
- 404
- 422
{- "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:
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 ( |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/clients/%7Bid%7D/forms?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&expand=SOME_ARRAY_VALUE&type=SOME_STRING_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
{- "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
}
Retrieve a form for a client
Retrieve a form for a client.
Authorizations:
path Parameters
id required | integer |
reference required | string <uuid> |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/clients/%7Bid%7D/forms/%7Breference%7D \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
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": [
- {
- "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
}
Download a form for a client
Download a form for a client.
Authorizations:
path Parameters
id required | integer |
reference required | string <uuid> |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/clients/%7Bid%7D/forms/%7Breference%7D/download \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
List all records for a client
List all records for a client.
Authorizations:
path Parameters
id required | integer |
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
expand | Array of strings Items Value: "client" |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/clients/%7Bid%7D/records?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&expand=SOME_ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
{- "object": "paginated_list",
- "data": [
- {
- "object": "record",
- "id": 983434,
- "status": "pending",
- "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
}
], - "total": 1,
- "count": 1,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
List all files for a client
List all files for a client.
Authorizations:
path Parameters
id required | integer |
query Parameters
expand | Array of strings Items Value: "source" |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/clients/%7Bid%7D/files?expand=SOME_ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
An internal file attached directly to the client.
{- "object": "paginated_list",
- "data": [
- {
- "object": "client_file",
- "id": 31788,
- "type": "internal",
- "source": {
- "id": 31788,
- "type": "client"
}, - "name": "73db4d13-6c1b-40b1-94fc-2cf6d7ac22d2.pdf",
- "attachment": {
- "object": "attachment",
- "id": 31782,
- "name": "73db4d13-6c1b-40b1-94fc-2cf6d7ac22d2.pdf",
- "original": "NDA-final.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
}
Download a file for a client
Download a file for a client.
Authorizations:
path Parameters
clientId required | integer |
fileId required | integer |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/clients/%7BclientId%7D/files/%7BfileId%7D/download \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
List all assignees for a client
Returns a paginated list of the client's assignees.
Authorizations:
path Parameters
id required | integer Unique client identifier. |
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/clients/%7Bid%7D/assignees?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 404
{- "object": "paginated_list",
- "data": [
- {
- "object": "assignee",
- "id": 34535,
- "type": "user",
- "user": {
- "object": "user",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - {
- "object": "assignee",
- "id": 34538,
- "type": "user",
- "user": {
- "object": "user",
- "id": 472,
- "name": "Dennis Jones",
- "email": "dennis@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-25T11:11:07Z",
- "updated_at": "2019-08-25T11:11:07Z"
}
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Set assignees for a client
Set the assignees for a client according to the exact values provided in the request, overwriting any existing assignees. To add additional assignees, refer to Update assignees for a client.
Authorizations:
path Parameters
id required | integer Unique client identifier. |
Request Body schema: application/json
type required | string Value: "user" The type of assignee to be assigned to the client. |
user required | integer The unique identifier of the user to be assigned to the client. |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
[- {
- "type": "user",
- "user": 121
}, - {
- "type": "user",
- "user": 472
}
]
Response samples
- 201
- 401
- 404
- 422
{- "object": "paginated_list",
- "data": [
- {
- "object": "assignee",
- "id": 34535,
- "type": "user",
- "user": {
- "object": "user",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - {
- "object": "assignee",
- "id": 34538,
- "type": "user",
- "user": {
- "object": "user",
- "id": 472,
- "name": "Dennis Jones",
- "email": "dennis@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-25T11:11:07Z",
- "updated_at": "2019-08-25T11:11:07Z"
}
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Update assignees for a client
Add one or more assignees to a client, merging them with existing assignees.
Authorizations:
path Parameters
id required | integer Unique client identifier. |
Request Body schema: application/json
type required | string Value: "user" The type of assignee to be assigned to the client. |
user required | integer The unique identifier of the user to be assigned to the client. |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
[- {
- "type": "user",
- "user": 523
}
]
Response samples
- 200
- 201
- 401
- 404
- 422
{- "object": "paginated_list",
- "data": [
- {
- "object": "assignee",
- "id": 34535,
- "type": "user",
- "user": {
- "object": "user",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - {
- "object": "assignee",
- "id": 34538,
- "type": "user",
- "user": {
- "object": "user",
- "id": 472,
- "name": "Dennis Jones",
- "email": "dennis@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-25T11:11:07Z",
- "updated_at": "2019-08-25T11:11:07Z"
}
}, - {
- "object": "assignee",
- "id": 34541,
- "type": "user",
- "user": {
- "object": "user",
- "id": 523,
- "name": "Clara Clayton",
- "email": "clara@example.com",
- "is_verified": true,
- "is_disabled": false,
- "created_at": "2019-08-25T13:54:32Z",
- "updated_at": "2019-08-25T13:54:32Z"
}
}
], - "total": 3,
- "count": 3,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
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:
path Parameters
id required | integer Unique client identifier. |
Request Body schema: application/json
Schema not providedResponses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request DELETE \ --url https://id.amiqus.co/api/v2/clients/%7Bid%7D/assignees \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ --header 'content-type: application/json'
Response samples
- 401
- 404
{- "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:
path Parameters
clientId required | integer Unique client identifier. |
assigneeId required | integer Unique assignee identifier. |
Request Body schema: application/json
Schema not providedResponses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request DELETE \ --url https://id.amiqus.co/api/v2/clients/%7BclientId%7D/assignees/%7BassigneeId%7D \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ --header 'content-type: application/json'
Response samples
- 401
- 404
{- "error": "Unauthenticated."
}
List all organisations for a client
Returns a paginated list of a client's organisation memberships.
To retrieve organisations for the team, refer to List all organisations.
Authorizations:
path Parameters
id required | integer Unique client identifier |
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/clients/%7Bid%7D/organisations?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 404
{- "object": "paginated_list",
- "data": [
- {
- "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"
}
], - "total": 1,
- "count": 1,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Update organisations for a client
Add the client to one or more organisations, merging them with existing organisation memberships.
To update an organisation's basic details, refer to Update an organisation.
Authorizations:
path Parameters
id required | integer Unique client identifier |
Request Body schema: application/json
Unique organisation identifier
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
[- 4117
]
Response samples
- 200
- 404
{- "object": "paginated_list",
- "data": [
- {
- "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"
}, - {
- "object": "organisation",
- "id": 4117,
- "name": "CusCo",
- "company_number": "11249",
- "jurisdiction": "us_ca",
- "created_at": "2022-03-20T13:12:41Z",
- "updated_at": "2022-03-20T13:12:41Z"
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Replace organisations for a client
Replaces a client's organisation memberships.
Authorizations:
path Parameters
id required | integer Unique client identifier |
Request Body schema: application/json
Unique organisation identifier
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
[- 3970,
- 4117
]
Response samples
- 200
- 401
- 404
{- "object": "paginated_list",
- "data": [
- {
- "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"
}, - {
- "object": "organisation",
- "id": 4117,
- "name": "CusCo",
- "company_number": "11249",
- "jurisdiction": "us_ca",
- "created_at": "2022-03-20T13:12:41Z",
- "updated_at": "2022-03-20T13:12:41Z"
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Delete organisations for a client
Delete all of a client's organisation memberships.
Authorizations:
path Parameters
id required | integer Unique client identifier |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request DELETE \ --url https://id.amiqus.co/api/v2/clients/%7Bid%7D/organisations \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 401
- 404
{- "error": "Unauthenticated."
}
Delete organisation for a client
Delete a single client organisation membership.
Authorizations:
path Parameters
clientId required | integer Unique client identifier |
organisationId required | integer Unique organisation identifier |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request DELETE \ --url https://id.amiqus.co/api/v2/clients/%7BclientId%7D/organisations/%7BorganisationId%7D \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 401
- 404
{- "error": "Unauthenticated."
}
List all steps
List all steps available for use.
Authorizations:
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/steps?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
{- "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
}
Validate steps
Validate steps and return costs.
Authorizations:
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 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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
Steps containing an identity check and a standard Photo ID check with passport and driving licence document types enabled.
{- "steps": [
- {
- "type": "check.identity"
}, - {
- "type": "check.photo_id",
- "preferences": {
- "report_type": "standard",
- "docs": [
- "passport",
- "driving_licence"
]
}
}
]
}
Response samples
- 200
Validated steps containing an identity check and a standard Photo ID check with passport and driving licence document types enabled.
{- "object": "validated_steps",
- "steps": [
- {
- "object": "validated_step",
- "type": "check.identity",
- "cost": 2
}, - {
- "object": "validated_step",
- "type": "check.photo_id",
- "cost": 2
}
]
}
List all team members
List all team members.
Authorizations:
path Parameters
teamId required | integer |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/teams/%7BteamId%7D/members \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
{- "object": "paginated_list",
- "data": [
- {
- "object": "team_member",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "role": "owner"
}, - {
- "object": "team_member",
- "id": 472,
- "name": "Dennis Jones",
- "email": "dennis@example.com",
- "role": "member"
}
], - "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:
path Parameters
teamId required | integer |
teamMemberId required | integer |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/teams/%7BteamId%7D/members/%7BteamMemberId%7D \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
{- "object": "team_member",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "role": "owner"
}
Retrieve 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:
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/organisations?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
{- "object": "paginated_list",
- "data": [
- {
- "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"
}
], - "total": 1,
- "count": 1,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Create an organisation
Create a new organisation.
Authorizations:
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 |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
{- "name": "Probert Publishing",
- "company_number": "SF12188",
- "jurisdiction": "gb"
}
Response samples
- 201
- 401
- 422
{- "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"
}
Retrieve an organisation
Returns a single organisation.
Authorizations:
path Parameters
id required | integer Unique organisation identifier |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/organisations/%7Bid%7D \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 404
{- "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"
}
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:
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 |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
{- "name": "Probert Publishing Co"
}
Response samples
- 200
- 401
- 404
- 422
{- "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"
}
List all documents
List all library documents.
Authorizations:
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
enabled | boolean |
expand | Array of strings Items Value: "attachment" |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/documents?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&enabled=SOME_BOOLEAN_VALUE&expand=SOME_ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
A single document with attachment expanded.
{- "object": "paginated_list",
- "data": [
- {
- "object": "document",
- "id": 3342,
- "name": "Non-disclosure agreement",
- "description": "Generic non-disclosure agreement",
- "is_enabled": true,
- "attachment": {
- "object": "attachment",
- "id": 43375,
- "name": "367452af-3931-4207-851a-adda324cd3d6.pdf",
- "original": "NDA-final.pdf",
- "type": "application/pdf",
- "size": 272534,
- "av_status": "clean",
- "created_at": "2022-08-17T13:56:05Z",
- "updated_at": "2022-08-17T13:56:05Z"
}, - "created_at": "2022-08-17T13:56:05Z",
- "updated_at": "2022-08-17T13:56:05Z"
}
], - "total": 1,
- "count": 1,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
List all email templates
List all email templates.
Authorizations:
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
enabled | boolean |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/templates/emails?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&enabled=SOME_BOOLEAN_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
{- "object": "paginated_list",
- "data": [
- {
- "object": "email_template",
- "id": 1383,
- "name": "NDA",
- "description": "Non-disclosure agreement",
- "content": "Itaque eum sint. Repudiandae odio quia doloremque fugit nisi sed. Qui omnis minima cumque minima amet minima illo.",
- "is_enabled": true,
- "created_at": "2022-08-24T11:26:22Z",
- "updated_at": "2022-08-24T11:26:22Z"
}, - {
- "object": "email_template",
- "id": 2119,
- "name": "Onboarding",
- "description": "A new client's onboarding request",
- "content": "Voluptatibus repellat aspernatur dolores non voluptatem sapiente esse id.\nTenetur illo enim harum repellat ex omnis nihil iure qui.\nQui aspernatur velit aut qui qui quis. Accusantium culpa est accusantium. Qui et in sit praesentium et. Ex labore nihil sunt fugit exercitationem quis quia suscipit.",
- "is_enabled": false,
- "created_at": "2022-09-02T08:14:51Z",
- "updated_at": "2022-09-02T08:14:51Z"
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
List all document templates
List all document templates.
Authorizations:
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
enabled | boolean |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/templates/documents?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&enabled=SOME_BOOLEAN_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
{- "object": "paginated_list",
- "data": [
- {
- "object": "document_template",
- "id": 88456,
- "name": "Utility bill",
- "description": "Bill dated within three months",
- "content": "Please upload a utility bill showing your name and current address dated within the last three months.",
- "is_enabled": true,
- "created_at": "2022-08-27T13:03:54Z",
- "updated_at": "2022-08-27T13:03:54Z"
}
], - "total": 1,
- "count": 1,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
List all record templates
Note: The List all record templates endpoint is partially implemented. Some properties are temporarily unavailable.
List all record templates returns a paginated list of record templates associated with the team.
Authorizations:
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
enabled | boolean |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/templates/records?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&enabled=SOME_BOOLEAN_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
{- "object": "paginated_list",
- "data": [
- {
- "object": "record_template",
- "id": 43723,
- "name": "Identity verification",
- "description": "Identity verification for new clients",
- "presets": {
- "steps": [
- {
- "object": "step",
- "type": "check.photo_id",
- "preferences": {
- "report_type": "standard",
- "face": true,
- "liveness": true,
- "facial_similarity": true,
- "live_document": true,
- "docs": [
- "passport",
- "driving_licence",
- "national_id"
]
}
}, - {
- "object": "step",
- "type": "document.request",
- "preferences": {
- "title": "Utility bill",
- "instructions": "A utility bill dated within the last three months."
}
}
], - "notification": "email",
- "message": "Modi praesentium incidunt optio corrupti. Error sunt et atque ut qui facere ipsa sed. Illo ut voluptas numquam sapiente.\nInventore est nisi animi et consequatur iure deserunt quam reiciendis. Dolor eligendi tempora id aut quos temporibus asperiores omnis necessitatibus. Vel vel nihil autem alias dignissimos.\nQuia dolores et sequi est rem. Neque at debitis facere ullam ut eligendi distinctio cumque itaque. Eum dignissimos ea. Reiciendis corporis hic sunt cupiditate dolor est. Saepe et qui unde earum et eum est. Qui architecto maxime ab aut dolor voluptatum qui sed consequatur.",
- "reminder": true
}, - "is_enabled": true,
- "created_at": "2022-08-13T14:12:53Z",
- "updated_at": "2022-08-13T14:12:53Z"
}, - {
- "object": "record_template",
- "id": 43812,
- "name": "Onboarding",
- "description": "Onboarding for new staff members",
- "presets": {
- "steps": [
- {
- "object": "step",
- "type": "check.criminal_record",
- "preferences": {
- "region": "scotland",
- "enable_payment": false
}
}, - {
- "object": "step",
- "type": "check.photo_id",
- "preferences": {
- "report_type": "standard",
- "face": true,
- "liveness": true,
- "facial_similarity": true,
- "live_document": true,
- "docs": [
- "passport",
- "driving_licence"
]
}
}
], - "notification": "email",
- "message": "Welcome to the team, please complete the onboarding steps.",
- "reminder": false,
- "assignees": [
- 623,
- 626
]
}, - "is_enabled": true,
- "created_at": "2022-08-24T11:26:22Z",
- "updated_at": "2022-08-24T11:26:22Z"
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
List all webhooks
Returns a paginated list of webhooks.
To retrieve a webhook, refer to Retrieve a webhook.
Authorizations:
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
enabled | boolean |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/webhooks?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&enabled=SOME_BOOLEAN_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
{- "object": "paginated_list",
- "data": [
- {
- "object": "webhook",
- "id": 2154,
- "uuid": "e4085749-1c11-4ac8-9361-df7f33c37ecb",
- "secret": "58585568aa4dc44c733bc244495fc1f2de3c2d2f56287c265274ab806f74bb34",
- "events": [
- "client.*",
- "record.*"
], - "is_enabled": true,
- "created_at": "2022-08-24T11:26:22Z",
- "updated_at": "2022-08-24T11:26:22Z"
}, - {
- "object": "webhook",
- "id": 2159,
- "uuid": "0c416908-3a4a-4ee5-96fb-a780783e8b64",
- "events": [
- "*"
], - "is_enabled": true,
- "secret": "44c733bc56287c265274ab806f74bb34244495fc1f2de3c2d2f58585568aa4dc",
- "created_at": "2022-08-24T12:05:53Z",
- "updated_at": "2022-08-24T12:05:53Z"
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Create a webhook
Create a webhook.
Authorizations:
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; |
is_enabled | boolean Default: true Whether or not the webhook is currently enabled. |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
{- "events": [
- "client.*",
- "record.*"
]
}
Response samples
- 201
- 401
- 422
{- "object": "webhook",
- "id": 2154,
- "uuid": "e4085749-1c11-4ac8-9361-df7f33c37ecb",
- "secret": "58585568aa4dc44c733bc244495fc1f2de3c2d2f56287c265274ab806f74bb34",
- "events": [
- "client.*",
- "record.*"
], - "is_enabled": true,
- "created_at": "2022-08-24T11:26:22Z",
- "updated_at": "2022-08-24T11:26:22Z"
}
Retrieve a webhook
Retrieve a webhook.
Authorizations:
path Parameters
id required | integer Unique webhook identifier. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/webhooks/%7Bid%7D \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 404
{- "object": "webhook",
- "id": 2154,
- "uuid": "e4085749-1c11-4ac8-9361-df7f33c37ecb",
- "secret": "58585568aa4dc44c733bc244495fc1f2de3c2d2f56287c265274ab806f74bb34",
- "events": [
- "client.*",
- "record.*"
], - "is_enabled": true,
- "created_at": "2022-08-24T11:26:22Z",
- "updated_at": "2022-08-24T11:26:22Z"
}
Update a webhook
Update a webhook.
Authorizations:
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; |
is_enabled | boolean Whether or not the webhook is currently enabled. |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
Update both the URL and subscribed events.
{- "events": [
- "client.*"
]
}
Response samples
- 200
- 401
- 404
- 422
{- "object": "webhook",
- "id": 2154,
- "uuid": "e4085749-1c11-4ac8-9361-df7f33c37ecb",
- "secret": "58585568aa4dc44c733bc244495fc1f2de3c2d2f56287c265274ab806f74bb34",
- "events": [
- "client.*",
- "record.*"
], - "is_enabled": true,
- "created_at": "2022-08-24T11:26:22Z",
- "updated_at": "2022-08-24T11:26:22Z"
}
Delete a webhook
Delete a webhook.
Authorizations:
path Parameters
id required | integer Unique webhook identifier. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request DELETE \ --url https://id.amiqus.co/api/v2/webhooks/%7Bid%7D \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 404
{- "error": "Webhook not found"
}
List all deliveries for a webhook
List all deliveries for a webhook.
Authorizations:
path Parameters
id required | integer Unique webhook identifier. |
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/webhooks/%7Bid%7D/deliveries?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 404
Example of a successful delivery for a ping
event.
{- "object": "paginated_list",
- "data": [
- {
- "object": "webhook_delivery",
- "id": 4532,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "event": "ping",
- "attempts": 1,
- "request": {
- "method": "POST",
- "headers": {
- "Content-Length": "1234",
- "Host": "example.org",
- "User-Agent": "Amiqus AmiqusID/8927532",
- "Content-Type": "application/json",
- "X-AQID-Signature": "I4BqQLTTfg1i24UFa9o9wS+qf+lo9BVeuBlO6tS5Y20=",
- "X-AQID-Delivery-Id": "d7583a16-ad9e-4ec8-a53f-ffc67fd2445c"
}, - "body": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "event": "ping",
- "sent_at": "2019-08-24T14:15:22Z",
- "data": [
- "ping"
]
}
}, - "response": {
- "status_code": "204",
- "headers": {
- "Cache-Control": "no-cache, private",
- "Date": "Mon, 22 Aug 2022 16:20:33 GMT"
}, - "body": { }
}, - "last_sent_at": "2019-08-24T14:15:22Z"
}
], - "total": 1,
- "count": 1,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
List all forms
List all forms.
Authorizations:
query Parameters
page | integer >= 1 |
limit | integer [ 1 .. 100 ] |
enabled | boolean |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/forms?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&enabled=SOME_BOOLEAN_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
{- "object": "paginated_list",
- "data": [
- {
- "object": "form_template",
- "id": 45533,
- "reference": "9b81f60f-2165-4e2c-b748-6c3071053e66",
- "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"
]
}, - {
- "id": "4",
- "type": "radio",
- "label": {
- "value": "Contract type",
- "options": [
- "Full-time",
- "Part-time"
]
}, - "validation": [
- "required"
]
}
], - "version": 4,
- "is_enabled": true,
- "created_at": "2022-08-24T11:26:22Z",
- "updated_at": "2022-08-24T11:26:22Z",
- "archived_at": null
}
], - "total": 1,
- "count": 1,
- "limit": 100,
- "current_page": 1,
- "total_pages": 1,
- "links": null
}
Create a form
Create a form.
Authorizations:
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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
A simple form with two required fields inside a section.
{- "name": "New starter form",
- "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"
]
}, - {
- "id": "4",
- "type": "radio",
- "label": {
- "value": "Contract type",
- "options": [
- "Full-time",
- "Part-time"
]
}, - "validation": [
- "required"
]
}
]
}
Response samples
- 201
{- "object": "form_template",
- "id": 45533,
- "reference": "9b81f60f-2165-4e2c-b748-6c3071053e66",
- "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"
]
}, - {
- "id": "4",
- "type": "radio",
- "label": {
- "value": "Contract type",
- "options": [
- "Full-time",
- "Part-time"
]
}, - "validation": [
- "required"
]
}
], - "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:
path Parameters
reference required | string <uuid> |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url https://id.amiqus.co/api/v2/forms/%7Breference%7D \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
{- "object": "form_template",
- "id": 45533,
- "reference": "9b81f60f-2165-4e2c-b748-6c3071053e66",
- "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"
]
}, - {
- "id": "4",
- "type": "radio",
- "label": {
- "value": "Contract type",
- "options": [
- "Full-time",
- "Part-time"
]
}, - "validation": [
- "required"
]
}
], - "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:
path Parameters
reference required | string <uuid> |
Request Body schema: application/json
non-emptyname | 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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
Update the "New starter form" adding a new multple choice answer.
{- "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"
]
}, - {
- "id": "4",
- "type": "radio",
- "label": {
- "value": "Contract type",
- "options": [
- "Full-time",
- "Part-time",
- "Contractor"
]
}, - "validation": [
- "required"
]
}
]
}
Response samples
- 200
{- "object": "form_template",
- "id": 45533,
- "reference": "9b81f60f-2165-4e2c-b748-6c3071053e66",
- "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"
]
},