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

# Create payment screening configuration

`POST /v2/payment-screening/configurations`

This endpoint allows you to create a new payment screening configuration.

Payment screening configurations define which lists a transaction will be screened against and the settings to apply to the search. You can create multiple configurations in your account and each configuration can have multiple versions.

Within the configuration are one or more source collections. A source collection contains:

* The sanctions lists you wish to screen against 
* A global fuzziness score (a spectrum with 0 as exact search, 100 as very broad search) 
* Name search options:
    * Name fuzziness score that, if present, overrides the global fuzziness
    * Search options
* Reference text search options:
    * Reference text fuzziness score that, if present, overrides the global fuzziness
    * Search options
* BIC search strictness    
    
In addition, you can choose to omit your customer from the screening.
        


You need "Access to base payment screening functionality" enabled to use this endpoint.

## Request body

- PsCreateConfigurationRequest
  - `configuration` PsConfiguration, required
    - `description` string, nullable
    - `name` string, required
    - `source_collections` PsSourceCollection[], required
      - `bic_settings` PsBicSettings
        - `options` string[], nullable
        - `strictness` 'BANK' | 'COUNTRY' | 'LOCATION' | 'BRANCH', nullable — Choose how strict you want the BIC search to be. BANK is the least strict, returning a match for any BIC matching the first 4 digits, COUNTRY returns a match on the first 6 digits, LOCATION returns a match on the first 8 digits, and BRANCH requires a match on 11 digits. If not supplied, the default is full match on the BIC, whether length is 8 or 11 digits.
      - `name` string, required
      - `name_settings` PsNameSettings
        - `ignored_parties` string[], nullable — Supply CUSTOMER and your customer will not be screened.
        - `name_fuzziness` number, float, nullable — A search fuzziness score between 0 and 1 by 0.1 increments, where 0 is a narrow search and 1 is a broad search.
        - `options` string[], nullable — Choose one or more of these options to use them in name searches.
      - `reference_text_settings` PsReferenceTextSettings
        - `options` string[], nullable — Choose one or more of these options to use them in reference text searches.
        - `reference_text_fuzziness` number, float, nullable — A search fuzziness score between 0 and 1 by 0.1 increments, where 0 is a narrow search and 1 is a broad search.
      - `source_identifiers` string[], required — Provide the source identifiers for the lists you want to screen against.
      - `source_type` 'SANCTION' | 'CUSTOM_LIST' | 'RISK_WORD_LIST', required — The type of sources in this collection. CUSTOM_LIST collections may only be used with name_screening_settings.

## Response `201`

Created

- PsCreateConfigurationResponse
  - `configuration` PsConfiguration, required
    - `description` string, nullable
    - `name` string, required
    - `source_collections` PsSourceCollection[], required
      - `bic_settings` PsBicSettings
        - `options` string[], nullable
        - `strictness` 'BANK' | 'COUNTRY' | 'LOCATION' | 'BRANCH', nullable — Choose how strict you want the BIC search to be. BANK is the least strict, returning a match for any BIC matching the first 4 digits, COUNTRY returns a match on the first 6 digits, LOCATION returns a match on the first 8 digits, and BRANCH requires a match on 11 digits. If not supplied, the default is full match on the BIC, whether length is 8 or 11 digits.
      - `name` string, required
      - `name_settings` PsNameSettings
        - `ignored_parties` string[], nullable — Supply CUSTOMER and your customer will not be screened.
        - `name_fuzziness` number, float, nullable — A search fuzziness score between 0 and 1 by 0.1 increments, where 0 is a narrow search and 1 is a broad search.
        - `options` string[], nullable — Choose one or more of these options to use them in name searches.
      - `reference_text_settings` PsReferenceTextSettings
        - `options` string[], nullable — Choose one or more of these options to use them in reference text searches.
        - `reference_text_fuzziness` number, float, nullable — A search fuzziness score between 0 and 1 by 0.1 increments, where 0 is a narrow search and 1 is a broad search.
      - `source_identifiers` string[], required — Provide the source identifiers for the lists you want to screen against.
      - `source_type` 'SANCTION' | 'CUSTOM_LIST' | 'RISK_WORD_LIST', required — The type of sources in this collection. CUSTOM_LIST collections may only be used with name_screening_settings.
  - `configuration_identifier` string, uuid, required
  - `created_at` string, date-time, required
  - `created_by` string, uuid, required
  - `version` integer, required

---

[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)