# Retrieve AML checks

Retrieves a list of AML checks.
These checks are records of customer data and potentially matching data in AML lists.

Endpoint: GET /aml-checks
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with . Multiple fields can be sorted by separating each with .

  - `filter` (string)
    Filters the collection items. This field requires
a special format. Use  for multiple allowed values.  Use  for multiple fields.

For more information, see
Using filter with collections.

  - `q` (string)
    Use this field to perform a partial search of text fields.

## Response 200 fields (application/json):

  - `id` (string)
    Unique resource ID.
    Example: "aml_chk_0YV8XJT2ZWDR398Q8NFEM7DEPM"

  - `createdTime` (string)
    Date and time which is set automatically when the resource is created.

  - `updatedTime` (string)
    Date and time which updates automatically when the resource is updated.

  - `websiteId` (string)
    Website ID associated with the customer.
    Example: "web_0YV7DE4Z26DQSA1AC92FBJ7SEG"

  - `reviewerId` (string,null)
    User ID of the person who reviewed the AML check.
    Example: "44433322-2c4y-483z-a0a9-158621f77a21"

  - `reviewerName` (string,null)
    First and last name of the person who reviewed the AML check.

  - `reviewStartTime` (string,null)
    Date and time when the AML check review is started.

  - `reviewTime` (string,null)
    Date and time when the AML check review is completed.

  - `priority` (string,null)
    Highest matched priority of all hits within an AML check.

  - `source` (string)
    Source of the AML check.
    Enum: "sign-up", "recurring", "purchase"

  - `status` (string)
    Status of the AML check.
    Enum: "pending-review", "in-review", "no-match", "confirmed-match", "false-positive"

  - `customer` (object)

  - `customer.id` (string)
    ID of the customer.

  - `customer.primaryAddress` (object)
    Customer's data at the time of the AML check.

  - `customer.primaryAddress.firstName` (string)
    Customer's first name at the time of the AML check.

  - `customer.primaryAddress.lastName` (string)
    Customer's last name at the time of the AML check.

  - `customer.primaryAddress.dob` (string,null)
    Customer's date of birth.
    Example: "1971-02-14"

  - `customer.primaryAddress.address` (string,null)
    First line of the customer's street address at the time of the AML check.
    Example: "36 Craven St"

  - `customer.primaryAddress.address2` (string,null)
    Second line of the customer's street address at the time of the AML check.

  - `customer.primaryAddress.city` (string,null)
    Customer's city of residence at the time of the AML check.
    Example: "Austin"

  - `customer.primaryAddress.region` (string,null)
    Customer's region of residence at the time of the AML check.
    Example: "Texas"

  - `customer.primaryAddress.country` (string,null)
    Customer's country of residence at the time of the AML check.

  - `customer.primaryAddress.postalCode` (string,null)
    Customer's postal code at the time of the AML check.
    Example: "WC2N 5NF"

  - `customer.tags` (array)
    List of tags that have been assigned to the customer.

  - `customer.tags.id` (string)
    ID of the tag.

  - `customer.tags.name` (string, required)
    Unique name for the tag.
Tag names are not case-sensitive.
    Example: "New"

  - `customer.tags.type` (string, required)
    Type of tag.
Tags of a specific type can only be assigned to corresponding entity types.
For example, you can only use customer tags on customers.
    Enum: "customer", "kyc-document", "aml-check"

  - `customer.tags._links` (array)
    Related links.

  - `customer.tags._links.href` (string)
    Link URL.

  - `customer.tags._links.rel` (string)
    Type of link.
    Enum: "self"

  - `customer.organizationId` (string)
    ID of the customer's organization.
    Example: "org_0YVDM8RC7GDADADSBSMW124JA8"

  - `hits` (array)
    List of hits returned during the AML check.

  - `hits.firstName` (string)
    First name of the individual, or name of entity.
    Example: "Benjamin"

  - `hits.lastName` (string,null)
    Last name of the individual. Returns a  value for single-named entities.
    Example: "Franklin"

  - `hits.source` (string)
    Describes which list the result is from.

  - `hits.sourceType` (array)
    Describes the categories of the individual or entity.
    Enum: "pep", "sanctions", "adverse-media", "enforcements", "state-owned-enterprise"

  - `hits.gender` (string,null)
    If =, this field describes the gender of the individual.

  - `hits.title` (array,null)
    Individual's job title.
    Example: ["Postmaster General","Ambassador to France","Ambassador to Sweden","Supreme Executive Council of Commonwealth of Pennsylvania"]

  - `hits.type` (string)
    Describes whether the source is an individual or an entity.
    Enum: "individual", "entity"

  - `hits.legalBasis` (array)
    List of references to legal documents, if they exist.

  - `hits.regime` (string,null)
    Describes the government, administration, or political entity.
    Example: "United States Government"

  - `hits.confidence` (string)
    Degree of confidence in the source list information.
    Enum: "weak", "medium", "strong", "very-strong"

  - `hits.nationality` (string)
    Nationality of the individual or entity.

  - `hits.address` (array)
    Addresses associated with the individual or entity.

  - `hits.address.address` (string,null)
    Street address line 1.

  - `hits.address.address2` (string,null)
    Street address line 2.

  - `hits.address.city` (string,null)
    City.

  - `hits.address.region` (string,null)
    State, province, or region.

  - `hits.address.country` (string,null)
    Country.

  - `hits.address.birthplace` (boolean)
    Individual's place of birth.

  - `hits.dob` (array)
    One or more possible dates of birth.
    Example: ["1706-01-17"]

  - `hits.aliases` (array)
    List of aliases, if any.

  - `hits.aliases.firstName` (string)
    First name of alias.

  - `hits.aliases.lastName` (string)
    Last name of alias.

  - `hits.aliases.authenticity` (string)
    Degree of confidence in the alias.
    Enum: "strong", "weak", "unknown"

  - `hits.passport` (array)
    Individual's passport information.

  - `hits.passport.number` (string)
    Passport number.

  - `hits.passport.registrationDate` (string)
    Passport registration date.

  - `hits.comments` (string,null)
    Additional information. This content varies per list.

  - `tags` (array)
    List of AML check tags.

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.