---
title: "Create an AML check"
method: POST
path: "/v1/checks/aml"
tags: ["AML check"]
---

# Create an AML check

`POST /v1/checks/aml`

Create an AML check.

---

#### See also  
Learn more about [Aml checks](./aml-checks-guide)

## Request body

- union
  - AmlCheckCompanyCreate
    - `company_id` string, uuid, required
    - `settings` AmlCheckSettingsCreate
      - `fuzziness` number, float — Level of flexibility of search (`0.00` will check without any fuzziness; `1.00` will look for results with even the slightest match in spelling and phonetics). Only applies to ComplyAdvantage vendor.
      - `exact_match` boolean — Exact match disables all standard and optional matching behaviors (Honorifics, affixes, initials, glued name, name variation, equivalent names, extra words in entity,...) 0% fuzziness disables 1 letter typo matching but keeps all other matching behaviors (standard and optional). Only applies to ComplyAdvantage vendor.
      - `list_types` string[] — Types of lists to apply for AML screening. Adverse media may triggers many potential matches. Only applies to ComplyAdvantage vendor.
      - `enable_entity_filter` boolean — Restrict hits according to entity type. False for broader search. Only applies to ComplyAdvantage vendor.
  - AmlCheckIndividualCreate
    - `individual_id` string, uuid, required
    - `settings` AmlCheckSettingsCreate
      - `fuzziness` number, float — Level of flexibility of search (`0.00` will check without any fuzziness; `1.00` will look for results with even the slightest match in spelling and phonetics). Only applies to ComplyAdvantage vendor.
      - `exact_match` boolean — Exact match disables all standard and optional matching behaviors (Honorifics, affixes, initials, glued name, name variation, equivalent names, extra words in entity,...) 0% fuzziness disables 1 letter typo matching but keeps all other matching behaviors (standard and optional). Only applies to ComplyAdvantage vendor.
      - `list_types` string[] — Types of lists to apply for AML screening. Adverse media may triggers many potential matches. Only applies to ComplyAdvantage vendor.
      - `enable_entity_filter` boolean — Restrict hits according to entity type. False for broader search. Only applies to ComplyAdvantage vendor.

## Response `201`

AML check has been created

**ℹ️ Click to see full payload**

- AmlCheck
  - `id` string, uuid, required
  - `company_id` string, uuid, nullable, required
  - `individual_id` string, uuid, nullable, required
  - `is_internal` boolean, required
  - `status` 'in_progress' | 'need_review' | 'processing' | 'approved' | 'rejected' | 'expired', required — ℹ️ Check status `expired` is deprecated and will be removed Q1'25. It will be replaced with an expired flag.
  - `type` 'aml', required
  - `subtype` string, nullable, required — Currently always null for `aml` Check
  - `last_activity_at` string, date-time, required — Latest activity date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
  - `data` AmlCheckData, required
    - `result` 'approved' | 'rejected' | 'error', nullable, required
    - `settings` union, required
      - AmlCheckDataComplyAdvantageSettings
        - `vendor` 'comply_advantage', required
        - `fuzziness` number, float, required
        - `exact_match` boolean, required
        - `list_types` string[], nullable, required — Types of lists to apply for AML screening. Can be null if `profile_id` is configure in your workspace.
        - `profile_id` string, nullable, required — Search Profile Id to use a specific search profile. Search profile are configured by your Dotfile CSM, contact us if needed. This will override the `list_types`.
        - `enable_entity_filter` boolean, required
      - AmlCheckDataComplyAdvantageMeshSettings
        - `vendor` 'comply_advantage_mesh', required
      - AmlCheckDataWorldcheckSettings
        - `vendor` 'worldcheck', required
        - `is_media_check_enabled` boolean, required — Whether MediaCheck (adverse media screening) was enabled for this check.
    - `vendor` union, required
      - AmlCheckDataComplyAdvantageVendor
        - `is_search_monitored` boolean, required
        - `created_at` string, date-time, required — Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
        - `name` 'comply_advantage', required
        - `search_url` string, required
        - `search_id` string, required
        - `search_ref` string, required
      - AmlCheckDataComplyAdvantageMeshVendor
        - `is_search_monitored` boolean, required
        - `created_at` string, date-time, required — Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
        - `name` 'comply_advantage_mesh', required
        - `customer_id` string, required
      - AmlCheckDataWorldCheckVendor
        - `is_search_monitored` boolean, required
        - `created_at` string, date-time, required — Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
        - `name` 'worldcheck', required
        - `case_url` string, required
        - `results_count` AmlCheckDataWorldCheckVendorResultsCount
          - `watchlist` number
          - `mediacheck` number
    - `review` Review, required
      - `comment` string, nullable, required
      - `reviewed_at` string, date-time, nullable, required — Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
      - `reviewer_type` 'user' | 'system' | 'api', nullable, required
      - `user` NestedUser, required
        - `id` string, uuid, required
        - `first_name` string, required
        - `last_name` string, required
        - `email` string, email, required
    - `match_status` 'no_match' | 'potential_match' | 'false_positive' | 'true_positive', required
    - `hits_list_types` string[], required — `sanction` `warning` `fitness_probity` `pep` `adverse_media` `law_enforcement` `special_interest_categories` `regulatory_enforcement` `other_bodies`
    - `hits` AmlHit[], required
      - `id` string, uuid, required
      - `name` string, required
      - `list_types` string[], required
      - `status` 'no_match' | 'potential_match' | 'false_positive' | 'true_positive', required
      - `review` Review, required
        - `comment` string, nullable, required
        - `reviewed_at` string, date-time, nullable, required — Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
        - `reviewer_type` 'user' | 'system' | 'api', nullable, required
        - `user` NestedUser, required
          - `id` string, uuid, required
          - `first_name` string, required
          - `last_name` string, required
          - `email` string, email, required
      - `vendor` union, required
        - AmlCheckHitComplyAdvantageVendor
          - `hit_id` string, required
          - `updated_by_monitoring_status` 'new' | 'updated' | 'removed', nullable, required
          - `updated_by_monitoring_at` string, date-time, nullable, required — Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
          - `name` 'comply_advantage', required
        - AmlCheckHitComplyAdvantageMeshVendor
          - `hit_id` string, required
          - `updated_by_monitoring_status` 'new' | 'updated' | 'removed', nullable, required
          - `updated_by_monitoring_at` string, date-time, nullable, required — Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
          - `name` 'comply_advantage_mesh', required
          - `risk_id` string, required
        - AmlCheckHitWorldcheckVendor
          - `hit_id` string, required
          - `updated_by_monitoring_status` 'new' | 'updated' | 'removed', nullable, required
          - `updated_by_monitoring_at` string, date-time, nullable, required — Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
          - `name` 'worldcheck', required

## Other responses

- `400` — The request is either malformed or contain invalid parameters. - Make sure the body payload matches the expected schema - Limit reached. Contact us at support@dotfile.com to lift all limits.

---

[API](https://skmtc.dev/dotfile/apis/api-specifications.md) · [All operations](https://skmtc.dev/dotfile/apis/api-specifications/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dotfile/api-specifications/revisions/36393567057b/schema)