---
title: "Create screening configuration"
method: POST
path: "/v2/entity-screening/configurations"
tags: ["Screening Configurations"]
---

# Create screening configuration

`POST /v2/entity-screening/configurations`

This endpoint creates a new screening configuration


You need "Access to base customer screening functionality" enabled and the "Create and update customer screening configurations" permission to use this endpoint.

## Request body

- SraCreateConfigurationRequest — Create configuration request containing a change reason and a screening configuration with multiple collections.
  - `change_reason` string, nullable — The reason for the change/creation. Defaults to "Initial creation"
  - `configuration` SraConfiguration — Object containing a screening configuration with multiple collections.
    - `configuration_options` string[], nullable — Configurations to be used across all collections, not the same as options inside a collection
    - `country_filters` string[], required — Country based screening results filtering
    - `description` string, required — The description of the screening configuration.
    - `is_archived` boolean, required — The flag to indicate if the screening configuration is archived.
    - `name` string, required — The name and identifier of the screening configuration.
    - `results_limit` 10 | 25 | 50 | 100 | 500, required — The limit of screening results returned
    - `source_collections` SraCollection[], required — The list of collections.
      - `aml_types` string[], required — The list of available AML types for the collection.
      - `custom_list_identifiers` string[], nullable — The list of available custom lists for the collection.
      - `description` string, required — The description of the collection.
      - `fuzziness` number, float, required — The fuzziness of the collection.
      - `name` string, required — The name and identifier of the collection.
      - `options` string[], required — The list of available options for the collection.
      - `source_identifiers` string[], required — The list of available sources for the collection.

## Response `201`

Configuration successfully created

- SraScreeningConfiguration — The response schema for a screening configuration.
  - `change_reason` string, nullable — The reason for the change in the screening configuration.
  - `configuration` SraConfiguration — Object containing a screening configuration with multiple collections.
    - `configuration_options` string[], nullable — Configurations to be used across all collections, not the same as options inside a collection
    - `country_filters` string[], required — Country based screening results filtering
    - `description` string, required — The description of the screening configuration.
    - `is_archived` boolean, required — The flag to indicate if the screening configuration is archived.
    - `name` string, required — The name and identifier of the screening configuration.
    - `results_limit` 10 | 25 | 50 | 100 | 500, required — The limit of screening results returned
    - `source_collections` SraCollection[], required — The list of collections.
      - `aml_types` string[], required — The list of available AML types for the collection.
      - `custom_list_identifiers` string[], nullable — The list of available custom lists for the collection.
      - `description` string, required — The description of the collection.
      - `fuzziness` number, float, required — The fuzziness of the collection.
      - `name` string, required — The name and identifier of the collection.
      - `options` string[], required — The list of available options for the collection.
      - `source_identifiers` string[], required — The list of available sources for the collection.
  - `configuration_identifier` string, uuid, nullable — The screening configuration identifier.
  - `created_at` string, date-time, nullable — Timestamp of when the screening configuration was created.
  - `created_by` string, uuid, nullable — The unique identifier of the user who created the screening configuration.
  - `version` integer, nullable — The version of the screening configuration.

## Other responses

- `400` — Bad Request

---

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