Amiqus ID REST API (2.0)
Download OpenAPI specification:Download
Amiqus ID API reference.
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=INTEGER_VALUE&limit=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
- 403
{- "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=INTEGER_VALUE&limit=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 credit history
Return a list of credit usage history
Authorizations:
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
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
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
- 200
- 401
- 403
- 500
{- "object": "paginated_list",
- "data": [
- {
- "object": "credit_history",
- "id": 1,
- "credits": 244,
- "reason": "Monthly topup",
- "created_at": "2024-09-18T12:42:23Z",
- "causer": {
- "id": 72343,
- "type": "user"
}
}, - {
- "object": "credit_history",
- "id": 2,
- "credits": -1,
- "reason": null,
- "created_at": "2024-09-23T12:56:39Z",
- "causer": {
- "id": 1,
- "type": "check"
}
}
], - "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 ] |
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: |
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 | integer Filter records created by team member user ID |
integer or boolean Filter records assigned to team member user ID or use | |
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
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
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
- 200
- 401
{- "object": "paginated_list",
- "data": [
- {
- "object": "record",
- "id": 983434,
- "status": "pending",
- "email": "marty@example.com",
- "client": 73845,
- "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"
], - "issuing_countries": null,
- "right_to_work": null
}, - "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
}
], - "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
}
], - "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 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
- 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",
- "docs": [
- "passport",
- "driving_licence"
]
}
}
], - "notification": "email"
}
Response samples
- 201
- 401
- 403
- 422
{- "object": "record",
- "id": 983434,
- "status": "pending",
- "email": "marty@example.com",
- "client": 7832,
- "steps": [
- {
- "object": "step",
- "id": 2,
- "type": "check.photo_id",
- "preferences": {
- "report_type": "standard",
- "face": false,
- "liveness": false,
- "facial_similarity": false,
- "live_document": false,
- "docs": [
- "passport",
- "driving_licence"
], - "issuing_countries": null,
- "right_to_work": null
}, - "check": 82342,
- "cost": 1,
- "completed_at": null
}
], - "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:
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=ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 403
- 404
{- "object": "record",
- "id": 983434,
- "status": "pending",
- "email": "marty@example.com",
- "client": 73845,
- "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"
], - "issuing_countries": null,
- "right_to_work": null
}, - "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
}
], - "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:
path Parameters
id required | integer Unique record identifier. |
Request Body schema: application/jsonrequired
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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
{- "is_archived": true,
- "is_reviewed": true,
- "expired_at": true
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "object": "record",
- "id": 983434,
- "status": "pending",
- "email": "marty@example.com",
- "client": 73845,
- "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"
], - "issuing_countries": null,
- "right_to_work": null
}, - "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
}
], - "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:
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=ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 403
{- "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,
- "national_insurance_number": 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": "banking_information",
- "record": { },
- "status": "pending",
- "response": {
- "object": "check_response.photo_id",
- "status": "processing",
- "result": "clear",
- "reports": [
- {
- "type": "document",
- "status": "processing",
- "result": "clear",
- "breakdown": {
- "age_validation": {
- "result": "clear",
- "breakdown": {
- "minimum_accepted_age": null
}
}, - "compromised_document": {
- "result": "clear",
- "breakdown": {
- "document_database": null,
- "repeat_attempts": null
}
}, - "data_comparison": {
- "result": "clear",
- "breakdown": {
- "first_name": null,
- "last_name": null,
- "date_of_birth": null
}
}, - "data_consistency": {
- "result": "clear",
- "breakdown": {
- "issuing_country": null,
- "document_numbers": null,
- "nationality": null,
- "gender": null,
- "document_type": null,
- "date_of_expiry": null,
- "date_of_birth": null,
- "last_name": null,
- "first_name": null
}
}, - "data_validation": {
- "result": "clear",
- "breakdown": {
- "mrz": null,
- "document_expiration": null,
- "expiry_date": null,
- "date_of_birth": null,
- "gender": null,
- "document_numbers": null
}
}, - "image_integrity": {
- "result": "clear",
- "breakdown": {
- "supported_document": { },
- "image_quality": { },
- "colour_picture": { },
- "conclusive_document_quality": { }
}
}, - "issuing_authority": {
- "result": "clear",
- "breakdown": {
- "nfc_passive_authentication": null,
- "nfc_active_authentication": null
}
}, - "police_record": {
- "result": "clear"
}, - "visual_authenticity": {
- "result": "clear",
- "breakdown": {
- "face_detection": null,
- "digital_tampering": null,
- "original_document_present": null,
- "picture_face_integrity": null,
- "security_features": null,
- "fonts": null,
- "template": null
}
}
}, - "document_data": {
- "document_type": "passport",
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "date_of_birth": "2019-08-24",
- "gender": "male",
- "document_numbers": [
- {
- "type": null,
- "value": null
}
], - "issuing_authority": "string",
- "issuing_country": "str",
- "issuing_state": "string",
- "issuing_date": "2019-08-24",
- "date_of_expiry": "2019-08-24",
- "mrz_line1": "string",
- "mrz_line2": "string",
- "mrz_line3": "string",
- "nationality": "str",
- "place_of_birth": "string",
- "nfc": {
- "document_type": "passport",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "date_of_birth": "2019-08-24",
- "gender": "male",
- "document_number": "string",
- "personal_number": "string",
- "nationality": "str",
- "place_of_birth": "string",
- "issuing_authority": "string",
- "issuing_country": "str",
- "issuing_date": "2019-08-24",
- "date_of_expiry": "2019-08-24",
- "mrz_line_1": "string",
- "mrz_line_2": "string"
}
}
}
], - "media": [
- {
- "type": "document",
- "attachment": {
- "object": "attachment",
- "id": 0,
- "name": "string",
- "original": "string",
- "type": "string",
- "size": 0,
- "av_status": "pending",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "document_type": "passport",
- "side": "front",
- "issuing_country": "str",
- "has_nfc": true
}
]
}, - "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
}
], - "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:
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=ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 403
- 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,
- "national_insurance_number": 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": "banking_information",
- "record": { },
- "status": "pending",
- "response": {
- "object": "check_response.photo_id",
- "status": "processing",
- "result": "clear",
- "reports": [
- {
- "type": "document",
- "status": "processing",
- "result": "clear",
- "breakdown": {
- "age_validation": {
- "result": "clear",
- "breakdown": {
- "minimum_accepted_age": null
}
}, - "compromised_document": {
- "result": "clear",
- "breakdown": {
- "document_database": null,
- "repeat_attempts": null
}
}, - "data_comparison": {
- "result": "clear",
- "breakdown": {
- "first_name": null,
- "last_name": null,
- "date_of_birth": null
}
}, - "data_consistency": {
- "result": "clear",
- "breakdown": {
- "issuing_country": null,
- "document_numbers": null,
- "nationality": null,
- "gender": null,
- "document_type": null,
- "date_of_expiry": null,
- "date_of_birth": null,
- "last_name": null,
- "first_name": null
}
}, - "data_validation": {
- "result": "clear",
- "breakdown": {
- "mrz": null,
- "document_expiration": null,
- "expiry_date": null,
- "date_of_birth": null,
- "gender": null,
- "document_numbers": null
}
}, - "image_integrity": {
- "result": "clear",
- "breakdown": {
- "supported_document": { },
- "image_quality": { },
- "colour_picture": { },
- "conclusive_document_quality": { }
}
}, - "issuing_authority": {
- "result": "clear",
- "breakdown": {
- "nfc_passive_authentication": null,
- "nfc_active_authentication": null
}
}, - "police_record": {
- "result": "clear"
}, - "visual_authenticity": {
- "result": "clear",
- "breakdown": {
- "face_detection": null,
- "digital_tampering": null,
- "original_document_present": null,
- "picture_face_integrity": null,
- "security_features": null,
- "fonts": null,
- "template": null
}
}
}, - "document_data": {
- "document_type": "passport",
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "date_of_birth": "2019-08-24",
- "gender": "male",
- "document_numbers": [
- {
- "type": null,
- "value": null
}
], - "issuing_authority": "string",
- "issuing_country": "str",
- "issuing_state": "string",
- "issuing_date": "2019-08-24",
- "date_of_expiry": "2019-08-24",
- "mrz_line1": "string",
- "mrz_line2": "string",
- "mrz_line3": "string",
- "nationality": "str",
- "place_of_birth": "string",
- "nfc": {
- "document_type": "passport",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "date_of_birth": "2019-08-24",
- "gender": "male",
- "document_number": "string",
- "personal_number": "string",
- "nationality": "str",
- "place_of_birth": "string",
- "issuing_authority": "string",
- "issuing_country": "str",
- "issuing_date": "2019-08-24",
- "date_of_expiry": "2019-08-24",
- "mrz_line_1": "string",
- "mrz_line_2": "string"
}
}
}
], - "media": [
- {
- "type": "document",
- "attachment": {
- "object": "attachment",
- "id": 0,
- "name": "string",
- "original": "string",
- "type": "string",
- "size": 0,
- "av_status": "pending",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "document_type": "passport",
- "side": "front",
- "issuing_country": "str",
- "has_nfc": true
}
]
}, - "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
}
], - "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:
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'
Response samples
- 403
{- "message": "This action is unauthorized."
}
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=INTEGER_VALUE&limit=INTEGER_VALUE&expand=check' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 403
{- "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"
], - "issuing_countries": null,
- "right_to_work": null
}, - "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=INTEGER_VALUE&limit=INTEGER_VALUE&expand=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
}
Retrieve a check
Retrieve a check.
Authorizations:
path Parameters
id required | integer Unique check identifier |
query Parameters
expand | Array of strings Items Enum: "record" "response" |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/checks/%7Bid%7D?expand=ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 403
- 404
A check that has not yet been completed.
{- "object": "check",
- "id": 82342,
- "type": "identity",
- "record": 983434,
- "status": "pending",
- "response": null,
- "allow_replay": true,
- "allow_cancel": true,
- "requires_consent": true,
- "created_at": "2022-05-22T08:22:12Z",
- "updated_at": "2022-05-22T08:22:12Z"
}
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=INTEGER_VALUE&limit=INTEGER_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 403
- 404
{- "object": "paginated_list",
- "data": [
- {
- "object": "assignee",
- "id": 34535,
- "type": "team_member",
- "team_member": {
- "object": "team_member",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "role": "owner"
}
}, - {
- "object": "assignee",
- "id": 34538,
- "type": "team_member",
- "team_member": {
- "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
}
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:
path Parameters
id required | integer Unique record identifier. |
Request Body schema: application/json
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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
[- {
- "type": "team_member",
- "team_member": 121
}, - {
- "type": "team_member",
- "team_member": 472
}
]
Response samples
- 201
- 401
- 403
- 404
- 422
{- "object": "list",
- "data": [
- {
- "object": "assignee",
- "id": 34535,
- "type": "team_member",
- "team_member": {
- "object": "team_member",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "role": "owner"
}
}, - {
- "object": "assignee",
- "id": 34538,
- "type": "team_member",
- "team_member": {
- "object": "team_member",
- "id": 472,
- "name": "Dennis Jones",
- "email": "dennis@example.com",
- "role": "member"
}
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "has_more": false,
}
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:
path Parameters
id required | integer Unique record identifier. |
Request Body schema: application/json
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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
[- {
- "type": "team_member",
- "team_member": 121
}, - {
- "type": "team_member",
- "team_member": 523
}
]
Response samples
- 201
- 401
- 403
- 404
- 422
{- "object": "list",
- "data": [
- {
- "object": "assignee",
- "id": 34535,
- "type": "team_member",
- "team_member": {
- "object": "team_member",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "role": "owner"
}
}, - {
- "object": "assignee",
- "id": 34541,
- "type": "team_member",
- "team_member": {
- "object": "team_member",
- "id": 523,
- "name": "Clara Clayton",
- "email": "clara@example.com",
- "role": "owner"
}
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "has_more": false,
}
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'
Response samples
- 401
- 403
- 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'
Response samples
- 401
- 403
- 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 ] |
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
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
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
- 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,
- "national_insurance_number": 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,
- "national_insurance_number": "QQ345678Z",
- "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,
- "national_insurance_number": "QQ123456C",
- "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
- 403
- 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,
- "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:
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
- 403
- 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,
- "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:
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
- 403
- 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,
- "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:
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'
Response samples
- 403
{- "message": "This action is unauthorized."
}
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
- 403
- 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
- 403
- 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=INTEGER_VALUE&limit=INTEGER_VALUE&expand=ARRAY_VALUE&type=STRING_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 403
{- "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
- 403
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'
Response samples
- 403
{- "message": "This action is unauthorized."
}
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=INTEGER_VALUE&limit=INTEGER_VALUE&expand=ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 403
{- "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"
], - "issuing_countries": null,
- "right_to_work": null
}, - "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 corrections for a client
Retrieve a paginated list of corrections for a client
Authorizations:
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
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
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
- 200
- 401
- 403
- 404
{- "object": "paginated_list",
- "data": [
- {
- "object": "client_correction",
- "id": 73823,
- "client": {
- "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,
- "national_insurance_number": null,
- "is_deletable": true,
- "created_at": "2022-05-21T14:15:22Z",
- "updated_at": "2022-05-21T14:15:22Z",
- "archived_at": null
}, - "record": 915732,
- "status": "pending",
- "correction": {
- "first_name": "Marty",
- "middle_name": "Seamus",
- "last_name": "McFly"
}, - "created_at": "2022-05-22T11:08:31Z",
- "updated_at": "2022-05-22T11:08:31Z"
}
], - "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:
path Parameters
clientId required | integer Unique client identifier. |
correctionId required | string Unique client correction identifier. |
Request Body schema: application/json
status required | string Value: "accepted" |
object non-empty |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
Accept the client correction as provided.
{- "status": "accepted"
}
Response samples
- 200
- 401
- 403
- 404
- 405
- 422
{- "object": "client_correction",
- "id": 34234,
- "client": 73823,
- "record": 915732,
- "status": "accepted",
- "correction": {
- "first_name": "Marty",
- "middle_name": "Seamus",
- "last_name": "McFly"
}, - "created_at": "2022-05-22T11:08:31Z",
- "updated_at": "2022-05-23T08:53:21Z"
}
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=INTEGER_VALUE&limit=INTEGER_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 403
- 404
{- "object": "paginated_list",
- "data": [
- {
- "object": "assignee",
- "id": 34535,
- "type": "team_member",
- "team_member": {
- "object": "team_member",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "role": "owner"
}
}, - {
- "object": "assignee",
- "id": 34538,
- "type": "team_member",
- "team_member": {
- "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
}
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:
path Parameters
id required | integer Unique client identifier. |
Request Body schema: application/json
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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
[- {
- "type": "team_member",
- "team_member": 121
}, - {
- "type": "team_member",
- "team_member": 472
}
]
Response samples
- 201
- 401
- 403
- 404
- 422
{- "object": "list",
- "data": [
- {
- "object": "assignee",
- "id": 34535,
- "type": "team_member",
- "team_member": {
- "object": "team_member",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "role": "owner"
}
}, - {
- "object": "assignee",
- "id": 34538,
- "type": "team_member",
- "team_member": {
- "object": "team_member",
- "id": 472,
- "name": "Dennis Jones",
- "email": "dennis@example.com",
- "role": "member"
}
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "has_more": false,
}
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:
path Parameters
id required | integer Unique client identifier. |
Request Body schema: application/json
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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
[- {
- "type": "team_member",
- "team_member": 121
}, - {
- "type": "team_member",
- "team_member": 523
}
]
Response samples
- 201
- 401
- 403
- 404
- 422
{- "object": "list",
- "data": [
- {
- "object": "assignee",
- "id": 34535,
- "type": "team_member",
- "team_member": {
- "object": "team_member",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "role": "member"
}
}, - {
- "object": "assignee",
- "id": 34541,
- "type": "team_member",
- "team_member": {
- "object": "team_member",
- "id": 523,
- "name": "Clara Clayton",
- "email": "clara@example.com",
- "role": "member"
}
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "has_more": false,
}
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'
Response samples
- 401
- 403
- 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'
Response samples
- 401
- 403
- 404
{- "error": "Unauthenticated."
}
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 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: |
source_type | string Enum: "photo_id" "reference" "banking_information" "employment_referencing" "requested" "sent" "returned" Some sources can be filtered by type:
Note: to filter by source type, the |
search | string Search for client files by name. Search is case-insensitive and fuzzy. |
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=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
- 200
- 403
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_by": {
- "object": "team_member",
- "id": 121,
- "name": "Lorraine Baines",
- "email": "lorraine@example.com",
- "role": "owner"
}, - "expires_at": "2027-08-24T23:59:59Z",
- "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
}
Create a file for a client
Create a file for a client.
Authorizations:
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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
{- "attachment": 31782,
- "name": "NDA-final",
- "expires_at": "2025-01-01T23:59:59Z"
}
Response samples
- 201
- 401
- 403
- 404
- 422
{- "object": "client_file",
- "id": 31788,
- "type": "internal",
- "source": {
- "id": 31788,
- "type": "client"
}, - "name": "NDA-final",
- "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_by": {
- "id": 121,
- "type": "team_member"
}, - "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:
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'
Response samples
- 401
- 403
- 404
- 410
- 423
{- "error": "Unauthenticated."
}
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:
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
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
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
- 200
- 401
- 403
- 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",
- "archived_at": null
}
], - "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:
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
- 201
- 403
- 404
- 422
Membership to 4117 already existed before the request.
{- "object": "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",
- "archived_at": null
}
], - "total": 1,
- "count": 1,
- "limit": 100,
- "has_more": false,
}
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:
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
- 201
- 401
- 403
- 404
- 422
{- "object": "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",
- "archived_at": null
}, - {
- "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",
- "archived_at": null
}
], - "total": 2,
- "count": 2,
- "limit": 100,
- "has_more": false,
}
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
- 403
- 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
- 403
- 404
{- "error": "Unauthenticated."
}
List all cases
List all cases.
Cases may not be enabled for all teams.
Authorizations:
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
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
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
- 200
- 401
{- "object": "paginated_list",
- "data": [
- {
- "object": "case",
- "id": 8723,
- "name": "Full-time onboarding",
- "reference": "AQFT123",
- "status": "pending",
- "client": 73845,
- "items": [
- 587,
- 698
], - "assignees": [
- 187,
- 947
], - "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 case
Create a case.
Cases may not be enabled for all teams.
Authorizations:
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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
{- "client": 7832,
- "name": "Full-time onboarding",
- "reference": "AQFT123"
}
Response samples
- 201
- 401
- 403
- 422
{- "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:
path Parameters
id required | integer The unique case identifier. |
query Parameters
expand | Array of strings Items Enum: "client" "items" "assignees" |
Responses
Request samples
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
curl --request GET \ --url 'https://id.amiqus.co/api/v2/cases/%7Bid%7D?expand=ARRAY_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 403
- 404
{- "object": "case",
- "id": 8723,
- "name": "Full-time onboarding",
- "reference": "AQFT123",
- "status": "pending",
- "client": 73845,
- "items": [
- 587,
- 698
], - "assignees": [
- 187,
- 947
], - "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:
path Parameters
id required | integer The unique case identifier. |
Request Body schema: application/json
non-emptyname | string The case name. |
reference | null or string The case reference. |
is_archived | boolean Allows toggling of archived state. |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
Update the case name and reference.
{- "name": "Part-time onboarding",
- "reference": "AQPT123"
}
Response samples
- 200
- 401
- 403
- 404
- 422
{- "object": "case",
- "id": 8723,
- "name": "Part-time onboarding",
- "reference": "AQPT123",
- "status": "pending",
- "client": 7832,
- "items": [
- 587,
- 698
], - "assignees": [
- 187,
- 947
], - "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:
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
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
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
- 200
- 401
- 403
- 404
{- "object": "paginated_list",
- "data": [
- {
- "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"
}
], - "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:
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.
|
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
{- "status": "approved"
}
Response samples
- 201
- 401
- 403
- 404
- 422
{- "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"
}
List all case items
Returns a paginated list of all case items.
Cases may not be enabled for all teams.
Authorizations:
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
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
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
- 200
- 401
- 403
- 404
{- "object": "paginated_list",
- "data": [
- {
- "object": "case_item",
- "id": 578,
- "entity": {
- "id": 73845,
- "type": "record"
}, - "created_at": "2022-05-21T12:15:31Z",
- "updated_at": "2022-05-21T12:15:31Z"
}
], - "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:
path Parameters
id required | integer The unique case identifier. |
Request Body schema: application/json
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
- Payload
- Shell + Curl
- Node + Request
- Javascript + Xhr
- Php + Http2
[- {
- "id": 983434,
- "type": "record"
}
]
Response samples
- 201
- 401
- 403