Glossary

This glossary defines the terms used in our API and maps them to the corresponding terms used in Amiqus. When the term Amiqus is used in this glossary, we are referring to the browser-based application, while when referencing API, we are referring to the Amiqus API.

API Terms

Team

A Team is an Amiqus account consisting of Amiqus users with the ability to onboard and verify the identity of Clients. A team member is the assignment of a user within team. Team members can have one of four roles within a team: Admin, Member, Read-only or Assignee only. Roles are assigned by a team member with an admin role. A user can be a team member of several teams with a different role on each.

Record

In the context of the API, a Record refers to a collection of Checks, Document Transfers, Document Requests, and Forms that your team has asked a Client to complete. In the product, this is referred to as a Request.

API Term: Record

Amiqus Term: Request

Client

In the context of the API, a Client refers to the person (candidate, applicant, employee etc) your Team wishes to engage with. In the Amiqus, referred to as Person (or People).

API Term: Client

Amiqus Term: Person

File

In the context of the API, a File is an uploaded file, either by a team member, or as part of a Record. Files are retrieved from endpoints "List all files for a client", "Download a file for a client". In the product, they are found in the Documents tab under the person you're viewing.

API Term: File

Amiqus Term: Document

Document

In the context of the API, a Document is a commonly used file that can be attached to a Record for a Client to download and are available under the endpoint "List all documents". In the product, they are found in Document attachments in your team's Workflow area.

API Term: Document

Amiqus Term: Document attachment

Document template

In the context of the API, Document template refers to a commonly used file uploader that can be added to a Record to accept supporting documentation from a Client. Uploaded files can be used for additional verification such as a utility bill. In the product, these are referred to as Document requests in your team's Workflow area.

Organisation

Clients working for the same company can be added to an Organisation. Information about the Organisation including incorporation data, company directors, ownership information and documentation can be retrieved from OpenCorporates and Companies House databases.

Step

A Record consists of one or more Steps. A Step can be a Check, Document Request, Document Transfer or Form, and a Record may have as many Steps as necessary. Only one of each Check type may be used within a Record.

Summary

API Term	Amiqus Term
Record	Request
Client	Person, People
File	Document
Document	Document attachment
Document template	Document request

Please contact developers@amiqus.co if you have any questions about these terms or if you need further clarification.