--- updatedAt: 2026-08-04T08:42:50.000Z agentTools: projectIndex: https://docs.mesh.complyadvantage.com/llms.txt --- # Create a new version of a configuration This endpoint creates a new version of a payment screening configuration. Specify the details of the new version, as you would when creating a new configuration. The new version will be created with an incremented version number. 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 PEP and watchlist data sources for payment screening" enabled to send a source collection that covers PEP or watchlist data. A source collection covers that data when its `types` include `PEP`, `PEP_CLASS_1` to `PEP_CLASS_4`, `WARNING` or `FITNESS_PROBITY`. A configuration that covers sanctions only does not need it. You need "Access to base payment screening functionality" enabled to use this endpoint. # OpenAPI definition ```json { "components": { "schemas": { "ps_BicSettings": { "properties": { "options": { "items": { "enum": [ "REMOVE_DELISTED_ENTITIES_SANCTION_ONLY" ], "type": "string" }, "nullable": true, "type": "array" }, "strictness": { "default": "BANK", "description": "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 BANK.", "enum": [ "BANK", "COUNTRY", "LOCATION", "BRANCH" ], "nullable": true, "type": "string" } }, "type": "object" }, "ps_Configuration": { "properties": { "description": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "source_collections": { "description": "The source collections this configuration screens against. At most four may screen name, at most four may screen BIC, and at most four may screen reference text.", "items": { "$ref": "#/components/schemas/ps_SourceCollection" }, "minItems": 1, "type": "array" } }, "required": [ "name", "source_collections" ], "type": "object" }, "ps_NameSettings": { "properties": { "ignored_parties": { "default": [], "description": "Supply CUSTOMER and your customer will not be screened.", "items": { "description": "Supply CUSTOMER and your customer will not be screened.", "enum": [ "CUSTOMER" ], "type": "string" }, "nullable": true, "type": "array", "uniqueItems": true }, "name_fuzziness": { "default": 0.5, "description": "A search fuzziness score between 0 and 1 by 0.1 increments, where 0 is a narrow search and 1 is a broad search.", "example": 0.8, "format": "float", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "options": { "default": [], "description": "Choose one or more of these options to use them in name searches.", "items": { "description": "Choose one or more of these options to use them in name searches.", "enum": [ "ALL_WORDS_MANDATORY", "ALLOW_NON_PHONETIC_FUZZY_MATCHES_SANCTION", "ALLOW_ONE_NON_PHONETIC", "ALLOW_ONE_NON_PHONETIC_FITNESS", "ALLOW_ONE_NON_PHONETIC_SANCTION", "ALLOW_ONE_NON_PHONETIC_WARNING", "FIRST_WORD_OPTIONAL", "LAST_WORD_OPTIONAL", "MORE_ARABIC_TRANSLITERATIONS_SANCTION", "REMOVE_DECEASED", "REMOVE_DELISTED_ENTITIES_SANCTION_ONLY", "REMOVE_EQUIVALENT_NAMES", "REMOVE_HOMOPHONES", "REMOVE_WEAK_ALIAS", "SPANISH_ADDED_MATERNAL", "WARNING_FITNESS_ENTITY_TYPE_FILTER" ], "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "ps_ProblemDetailErrorResponse": { "additionalProperties": true, "properties": { "detail": { "nullable": true, "type": "string" }, "identifier": { "format": "uuid", "type": "string" }, "instance": { "format": "uri", "nullable": true, "type": "string" }, "status": { "format": "int32", "nullable": true, "type": "integer" }, "timestamp": { "format": "date-time", "type": "string" }, "title": { "nullable": true, "type": "string" }, "type": { "format": "uri", "nullable": true, "type": "string" } }, "required": [ "identifier", "timestamp" ], "type": "object" }, "ps_ReferenceTextSettings": { "properties": { "options": { "default": [], "description": "Choose one or more of these options to use them in reference text searches.", "items": { "description": "Choose one or more of these options to use them in reference text searches.", "enum": [ "EXCLUDE_VESSELS", "REMOVE_DECEASED", "REMOVE_DELISTED_ENTITIES_SANCTION_ONLY", "REMOVE_EQUIVALENT_NAMES", "REMOVE_HOMOPHONES", "REMOVE_ONE_WORD_PERSON_ALIAS", "REMOVE_WEAK_ALIAS" ], "type": "string" }, "nullable": true, "type": "array" }, "reference_text_fuzziness": { "default": 0.5, "description": "A search fuzziness score between 0 and 1 by 0.1 increments, where 0 is a narrow search and 1 is a broad search.", "example": 0.8, "format": "float", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" } }, "type": "object" }, "ps_SourceCollection": { "properties": { "bic_settings": { "$ref": "#/components/schemas/ps_BicSettings" }, "name": { "type": "string" }, "name_settings": { "$ref": "#/components/schemas/ps_NameSettings" }, "outcome": { "default": "HOLD", "description": "What a hit against this collection does to the payment. HOLD blocks it pending review; ALLOW lets it settle and raises the alert for review afterwards.", "enum": [ "HOLD", "ALLOW" ], "example": "HOLD", "nullable": true, "type": "string" }, "reference_text_settings": { "$ref": "#/components/schemas/ps_ReferenceTextSettings" }, "source_identifiers": { "description": "Provide the source identifiers for the lists you want to screen against. A SANCTION, CUSTOM_LIST or RISK_WORD_LIST collection must name at least one. An INTERNAL collection may send an empty array, which screens every source carrying the types it declares.", "items": { "description": "Provide the source identifiers for the lists you want to screen against. A SANCTION, CUSTOM_LIST or RISK_WORD_LIST collection must name at least one. An INTERNAL collection may send an empty array, which screens every source carrying the types it declares.", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "source_type": { "default": "SANCTION", "description": "The type of sources in this collection. CUSTOM_LIST collections may only be used with name_screening_settings, and RISK_WORD_LIST collections only with reference_text_screening_settings. INTERNAL collections select what they screen with types rather than with source_identifiers.", "enum": [ "SANCTION", "CUSTOM_LIST", "RISK_WORD_LIST", "INTERNAL" ], "example": "SANCTION", "type": "string" }, "types": { "default": [], "description": "The AML types this collection covers. For every kind but INTERNAL the types record coverage only, and the search uses the identifiers in source_identifiers; an INTERNAL collection needs at least one type, and is searched by those types when it names no identifiers. Omit the types to record the coverage that the source_type implies. SANCTION collections cover sanctions. CUSTOM_LIST and RISK_WORD_LIST collections cover the listed sources alone. PEP and the PEP classes are screened on the name field only, and WARNING and FITNESS_PROBITY on the name and reference text fields. PEP covers every PEP class, so name a class only to narrow the search to it. PEP, the PEP classes, WARNING and FITNESS_PROBITY need \"Access to PEP and watchlist data sources for payment screening\" enabled on your account.", "items": { "enum": [ "SANCTION", "PEP", "PEP_CLASS_1", "PEP_CLASS_2", "PEP_CLASS_3", "PEP_CLASS_4", "WARNING", "FITNESS_PROBITY" ], "example": "SANCTION", "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "name", "source_identifiers", "source_type" ], "type": "object" }, "ps_UpdateConfigurationRequest": { "properties": { "change_reason": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/ps_Configuration" }, "is_archived": { "type": "boolean" } }, "required": [ "change_reason", "configuration", "is_archived" ], "type": "object" }, "ps_UpdateConfigurationResponse": { "properties": { "change_reason": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/ps_Configuration" }, "configuration_identifier": { "format": "uuid", "type": "string" }, "is_archived": { "type": "boolean" }, "updated_at": { "format": "date-time", "type": "string" }, "updated_by": { "format": "uuid", "type": "string" }, "version": { "format": "int32", "type": "integer" } }, "required": [ "change_reason", "configuration", "configuration_identifier", "is_archived", "updated_at", "updated_by", "version" ], "type": "object" } }, "securitySchemes": { "BearerAuth": { "description": "HTTP Bearer Token Authentication", "scheme": "bearer", "type": "http" } } }, "info": { "title": "Mesh API", "version": "v2.0" }, "openapi": "3.0.3", "paths": { "/v2/payment-screening/configurations/{configuration_identifier}": { "put": { "description": "\nThis endpoint creates a new version of a payment screening configuration.\n\nSpecify the details of the new version, as you would when creating a new configuration. The new version will be created with an incremented version number.\n\nPayment 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.\n\nWithin the configuration are one or more source collections. A source collection contains:\n\n* The sanctions lists you wish to screen against\n* A global fuzziness score (a spectrum with 0 as exact search, 100 as very broad search) \n* Name search options:\n * Name fuzziness score that, if present, overrides the global fuzziness\n * Search options\n* Reference text search options:\n * Reference text fuzziness score that, if present, overrides the global fuzziness\n * Search options\n* BIC search strictness\n\nIn addition, you can choose to omit your customer from the screening.\n\nYou need \"Access to PEP and watchlist data sources for payment screening\" enabled to send a source collection that covers PEP or watchlist data. A source collection covers that data when its `types` include `PEP`, `PEP_CLASS_1` to `PEP_CLASS_4`, `WARNING` or `FITNESS_PROBITY`. A configuration that covers sanctions only does not need it.\n \n\n\nYou need \"Access to base payment screening functionality\" enabled to use this endpoint.", "operationId": "paymentScreeningUpdateConfiguration", "parameters": [ { "description": "configuration ID", "example": "91b47e18-7b4b-46e7-8e9b-7311bedc1115", "in": "path", "name": "configuration_identifier", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ps_UpdateConfigurationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ps_UpdateConfigurationResponse" } } }, "description": "Created" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ps_ProblemDetailErrorResponse" } } }, "description": "Not found" } }, "summary": "Create a new version of a configuration", "tags": [ "Payment Screening" ] } } }, "security": [ { "BearerAuth": [] } ], "servers": [ { "description": "ComplyAdvantage Mesh API", "url": "https://api.mesh.complyadvantage.com" } ], "tags": [ { "name": "Payment Screening" } ] } ```