Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Screening Configurations

Create screening configuration

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.

post/v2/entity-screening/configurations

Request body

change_reasonstring nullable

The reason for the change/creation. Defaults to "Initial creation"

Example request

{
  "configuration": {
    "configuration_options": [
      "media_snippet_id"
    ],
    "country_filters": [
      "GB"
    ],
    "description": "Configuration description",
    "name": "Configuration Name",
    "source_collections": [
      {
        "aml_types": [
          "pep-class-1",
          "pep-class-2"
        ],
        "custom_list_identifiers": [
          "add73965-d5f1-44ea-857d-1660fb0bdd70",
          "680ff6c0-c399-4fe5-ac6d-2cd428d836b5"
        ],
        "description": "Collection description",
        "fuzziness": 0.8,
        "name": "Collection Name",
        "options": [
          "sanction_option",
          "pep_option"
        ],
        "source_identifiers": [
          "S:ABC123",
          "S:1A2B3C"
        ]
      }
    ]
  }
}

Response

Configuration successfully created

change_reasonstring nullable

The reason for the change in the screening configuration.

configuration_identifierstring uuid nullable

The screening configuration identifier.

created_atstring date-time nullable

Timestamp of when the screening configuration was created.

created_bystring uuid nullable

The unique identifier of the user who created the screening configuration.

versioninteger nullable

The version of the screening configuration.

Example response

{
  "configuration": {
    "configuration_options": [
      "media_snippet_id"
    ],
    "country_filters": [
      "GB"
    ],
    "description": "Configuration description",
    "name": "Configuration Name",
    "source_collections": [
      {
        "aml_types": [
          "pep-class-1",
          "pep-class-2"
        ],
        "custom_list_identifiers": [
          "add73965-d5f1-44ea-857d-1660fb0bdd70",
          "680ff6c0-c399-4fe5-ac6d-2cd428d836b5"
        ],
        "description": "Collection description",
        "fuzziness": 0.8,
        "name": "Collection Name",
        "options": [
          "sanction_option",
          "pep_option"
        ],
        "source_identifiers": [
          "S:ABC123",
          "S:1A2B3C"
        ]
      }
    ]
  }
}