openapi: 3.0.3
info:
  version: "8"
  title: Real-Time Watchlist Screening
  description: >
    The Real-Time Watchlist Screening API supports screening party and payment information against lists of known or suspected parties that are involved in illegal activities, such as money laundering, terrorism financing, or other criminal behaviors.
  termsOfService: https://www.sas.com/en_us/legal/copyright.html
  contact:
    name: SAS Developers
    email: devex@sas.com
    url: https://developer.sas.com
servers:
  - url: http://example.com/watchlistScreening
    description: This is an example of a base URL.
tags:
  - name: Root
    description: Contains operations for the root resource.
  - name: Screening
    description: Contains the operations to screen named entities against a collection of watchlists.
  - name: Presets
    description: Contains the operations to create, read, update, and delete presets and channels. Presets are predefined options that control screening requests.
  - name: Screening Exceptions
    description: Contains the operations to create, read, update, and delete screening exceptions. Screening exceptions identify the profiles or conditions that, when matched, do not generate a hit during the screening process.
  - name: Watchlist Profiles
    description: Contains the operation to read watchlist profiles. A watchlist profile represents the publication of data on a sanctioned entity or individual by a given watchlist. A specific version of a watchlist profile is identified by the unique pairing of its profile ID and checksum.
  - name: Watchlist Metadata
    description: Contains the operations to read watchlist metadata. The watchlist metadata contains information about a watchlist including its sanction codes and categories.
  - name: Watchlist Screening Statistics
    description: Contains the operation to read watchlist screening statistics.
paths:
  /:
    get:
      operationId: root
      summary: Get the list of watchlist screening resources
      description: Returns the watchlist screening resources.
      tags:
        - Root
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              description: The media type of the response body.
              schema:
                type: string
          content:
            application/vnd.sas.api+json:
              schema:
                $ref: "#/paths/~1/get/responses/200/content/application~1json/schema"
              examples:
                Root Collection:
                  $ref: "#/paths/~1/get/responses/200/content/application~1json/examples/Root%20Collection"
            application/json:
              schema:
                title: API
                description: The list of links to top-level resources and operations available from the root of the API.
                x-sas-media-type:
                  name: application/vnd.sas.api
                  version: 1
                required:
                  - version
                  - links
                properties:
                  version:
                    type: integer
                    description: The version number of the API representation. This is version 1.
                    minimum: 1
                  links:
                    description: The API's top-level links.
                    type: array
                    items:
                      $ref: "#/components/schemas/preset/properties/links/items"
              examples:
                Root Collection:
                  summary: Watchlist Screening Root Collection
                  description: A collection of watchlist screening resources.
                  value:
                    version: 1
                    links:
                      - method: POST
                        rel: screen entity
                        href: /watchlistScreening/entity
                        uri: /watchlistScreening/entity
                        type: application/json
                        itemType: application/json
                      - method: POST
                        rel: screen payment
                        href: /watchlistScreening/payment
                        uri: /watchlistScreening/payment
                        type: application/json
                        itemType: application/json
                      - method: POST
                        rel: create preset
                        href: /watchlistScreening/presets
                        uri: /watchlistScreening/presets
                        type: application/vnd.sas.watchlist.screening.preset
                        responseType: application/vnd.sas.watchlist.screening.preset
                      - method: GET
                        rel: get presets
                        href: /watchlistScreening/presets
                        uri: /watchlistScreening/presets
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.preset
                      - method: POST
                        rel: create profile exceptions
                        href: /watchlistScreening/exceptions
                        uri: /watchlistScreening/exceptions
                        type: application/vnd.sas.watchlist.screening.profile.exception
                        responseType: application/vnd.sas.watchlist.screening.profile.exception
                      - method: GET
                        rel: get profile exceptions
                        href: /watchlistScreening/exceptions
                        uri: /watchlistScreening/exceptions
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.profile.exception
                      - method: POST
                        rel: create conditional exceptions
                        href: /watchlistScreening/exceptions
                        uri: /watchlistScreening/exceptions
                        type: application/vnd.sas.watchlist.screening.conditional.exception
                        responseType: application/vnd.sas.watchlist.screening.conditional.exception
                      - method: GET
                        rel: get conditional exceptions
                        href: /watchlistScreening/exceptions
                        uri: /watchlistScreening/exceptions
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.conditional.exception
                      - method: GET
                        rel: get watchlist categories
                        href: /watchlistScreening/collection/categories
                        uri: /watchlistScreening/collection/categories
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.collection.categories
                      - method: GET
                        rel: get watchlist sanction codes
                        href: /watchlistScreening/collection/sanctionCodes
                        uri: /watchlistScreening/collection/sanctionCodes
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.collection.sanction.codes
                      - method: GET
                        rel: get watchlist regions
                        href: /watchlistScreening/collection/regions
                        uri: /watchlistScreening/collection/regions
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.collection.sanction.codes
                      - method: GET
                        rel: get settings
                        href: /watchlistScreening/settings
                        uri: /watchlistScreening/settings
                        type: application/vnd.sas.watchlist.screening.settings
        "404":
          description: The service is not available.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Service Unavailable:
                  summary: Error - Service Unavailable
                  description: The service is unavailable.
                  value:
                    version: 2
                    httpStatusCode: 404
                    message: Not Found
                    details: The service is unavailable.
  /settings:
    get:
      operationId: getSettings
      summary: Retrieve metadata about the solution
      description: Returns metadata about the SAS Real-Time Watchlist Screening configuration. This enables applications that require items such as the client reference identifier to obtain the value at runtime.
      tags:
        - Root
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.watchlist.screening.settings+json:
              schema:
                $ref: "#/components/schemas/watchlistScreeningSettings"
              examples:
                Settings:
                  $ref: "#/paths/~1settings/get/responses/200/content/application~1json/examples/Settings"
            application/json:
              schema:
                $ref: "#/components/schemas/watchlistScreeningSettings"
              examples:
                Settings:
                  summary: Watchlist Screening Settings
                  description: An object containing settings for the watchlist screening service.
                  value:
                    version: 1
                    clientReference: dev
        "404":
          $ref: "#/paths/~1/get/responses/404"
  /entity:
    post:
      operationId: screenEntity
      summary: Screen a group of entities
      description: Performs a screening action on a list of entities.
      tags:
        - Screening
      requestBody:
        description: A collection of entities to be screened and the options to use for this screening request.
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/entityScreening"
            examples:
              Screening Request:
                summary: Entity Screening Request
                description: An entity screening request with multiple party records.
                value:
                  message:
                    party:
                      - identifier: "00001"
                        name: Ashworth, Oscar Heath
                        type: individual
                        dateOfBirth:
                          - birthDt: 1960-03-13
                        gender: male
                        address:
                          - category: address
                            city: white pines bay
                            countryCode: usa
                        identity:
                          - number: "00001"
                      - identifier: "00002"
                        name: Smith, James
                        type: individual
                        dateOfBirth:
                          - birthDt: 1941-05-24
                        gender: male
                        address:
                          - category: pob
                            city: estes park
                            countryCode: usa
                      - identifier: "000003"
                        name: Sanctioned Airlines
                        type: entity
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/entityScreening"
              examples:
                Screening Response:
                  summary: Entity Screening Response
                  description: An entity screening response with multiple party records.
                  value:
                    message:
                      party:
                        - dateOfBirth:
                            - birthDt: 1960-03-13
                          gender: male
                          identifier: "00001"
                          identity:
                            - number: "00001"
                          address:
                            - category: address
                              city: white pines bay
                              countryCode: usa
                          name: Ashworth, Oscar Heath
                          alert:
                            comment: sanctions alert generated on SAN match
                            screeningOutcome: Alerted
                            type: SAN
                          screeningResult:
                            discardedHits: 1
                            hits: 2
                            remainingHits: 1
                            maxScore: 98
                            primaryName: Ashworth, Oscar Heath
                            matchedName: Ashworth, Oscar Heath
                            maxProximityScore: 100
                            tags:
                              - SAN
                            matchedProfile:
                              - alert:
                                  comment: alert was excluded
                                  screeningOutcome: Excluded
                                categories:
                                  - (Cat 1) Special Interest Person (SIP)
                                  - (Cat 2) Other Official Lists
                                  - (Cat 2) Sanctions Lists
                                checksum: -1727466793
                                coreChecksum: -2056675719
                                dateOfBirth:
                                  - birthDay: 13
                                    birthDt: 1960-03-13
                                    birthMonth: 3
                                    birthYear: 1960
                                exceptionId: 665ac66a-7960-498e-aaf5-0c4a6e2d188b
                                exceptionReference: CE_2c59e01d-5ed7-427d-a153-f304a0f2d899,
                                level: discarded
                                links:
                                  - method: GET
                                    rel: profile
                                    href: /watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793
                                    uri: /watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793
                                    type: application/json
                                  - method: GET
                                    rel: exception
                                    href: /watchlistScreening/exceptions/665ac66a-7960-498e-aaf5-0c4a6e2d188b
                                    uri: /watchlistScreening/exceptions/665ac66a-7960-498e-aaf5-0c4a6e2d188b
                                    type: application/vnd.sas.watchlist.screening.conditional.exception
                                locationFrom: 0
                                locationPath: /
                                locationTo: 21
                                matchType: /name/primary
                                matchedName: Ashworth, Oscar Heath
                                primaryName: Ashworth, Oscar Heath
                                mediaAgeScore: 0
                                mediaQuantityScore": 98
                                profileBirthPlaces:
                                  - city: phoenix
                                    countryCode: us
                                profileId: HMT0000000013272
                                profileLastUpdated: 2024-02-20T01:00:01.163Z
                                profilePlaces:
                                  - city: Pine Bay
                                    countryCode: us
                                profileGender: male
                                profileRelatedCountries:
                                  - us
                                profileStatus: UNK
                                profileType: individual
                                proximityScore: 100
                                sanctions:
                                  - HMT
                                score: 98
                                scoreScope:
                                  - COUNTRY
                                  - DOB
                                  - NAME
                                screened: Ashworth, Oscar Heath
                                tags:
                                  - SAN
                              - alert:
                                  screeningOutcome: Alerted
                                  comment: sanctions alert generated on SAN match
                                categories:
                                  - MUR
                                checksum: -1871588783
                                coreChecksum: -662103456
                                dateOfBirth:
                                  - birthDay: 13
                                    birthDt: 1960-03-13
                                    birthMonth: 3
                                    birthYear: 1960
                                level: medium
                                links:
                                  - method: GET
                                    rel: profile
                                    href: /watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783
                                    uri: /watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783
                                    type: application/json
                                locationFrom: 0
                                locationPath: /
                                locationTo: 21
                                matchType: /name/alias
                                matchedName: Ashworth, Heath
                                primaryName: Ashworth, Oscar
                                mediaAgeScore: 0
                                mediaQuantityScore": 36
                                profileId: OFAC000000018428
                                profileLastUpdated: 2024-02-20T01:15:01.163Z
                                profilePlaces:
                                  - city: Pine Bay
                                    countryCode: us
                                profileRelatedCountries:
                                  - us
                                profileStatus: UNK
                                profileType: individual
                                proximityScore: 100
                                sanctions:
                                  - OFACSD
                                score: 98
                                scoreScope:
                                  - COUNTRY
                                  - DOB
                                  - NAME
                                screened: Ashworth, Oscar Heath
                                tags:
                                  - SAN
                            messageReference: 120ef864-3e6b-423f-a8cb-307a3fc6d6af
                            statusCode: Success
                          type: individual
                        - dateOfBirth:
                            - birthDt: 1941-05-24
                          gender: male
                          identifier: "00002"
                          address:
                            - category: pob
                              city: estes park
                              countryCode: usa
                          alert:
                            comment: no hits returned
                            screeningOutcome: No Alert
                            type: null
                          name: Smith, James
                          screeningResult:
                            discardedHits: 0
                            hits: 0
                            remainingHits: 0
                            messageReference: 120ef864-3e6b-423f-a8cb-307a3fc6d6af
                            statusCode: Success
                          type: individual
                        - identifier: "000003"
                          name: Sanctioned Airlines
                          alert:
                            comment: sanctions alert generated on SAN match
                            screeningOutcome: Alerted
                            type: SAN
                          screeningResult:
                            discardedHits: 0
                            hits: 1
                            remainingHits: 1
                            maxScore: 98
                            primaryName: Sanctioned Airlines
                            matchedName: Sanctioned Airlines
                            maxProximityScore: 100
                            tags:
                              - SAN
                            matchedProfile:
                              - alert:
                                  comment: sanctions alert generated on SAN match
                                  screeningOutcome: Alerted
                                categories:
                                  - CUBA
                                checksum: -2108164488
                                coreChecksum: 576052857
                                level: low
                                locationFrom: 0
                                locationPath: /
                                locationTo: 19
                                links:
                                  - method: GET
                                    rel: profile
                                    href: /watchlistScreening/profiles/OFAC000000000036?checksum=-2108164488
                                    uri: /watchlistScreening/profiles/OFAC000000000036?checksum=-2108164488
                                    type: application/json
                                matchType: /name/primary
                                matchedName: Sanctioned Airlines
                                primaryName: Sanctioned Airlines
                                mediaAgeScore: 0
                                mediaQuantityScore": 58
                                profileId: OFAC000000000036
                                profileLastUpdated: 2024-02-20T01:00:01.163Z
                                profilePlaces:
                                  - city: Havana
                                    countryCode: cu
                                profileRelatedCountries:
                                  - cu
                                profileStatus: UNK
                                profileType: entity
                                proximityScore: 100
                                score: 100
                                scoreScope:
                                  - NAME
                                screened: Sanctioned Airlines
                                tags:
                                  - SAN
                            messageReference: 120ef864-3e6b-423f-a8cb-307a3fc6d6af
                            statusCode: Success
                          type: entity
                      screeningOptions:
                        chnEntity: sample_chn_realtime_entity
                        chnIndividual: sample_chn_realtime_individual
                        chnUnknown: sample_chn_realtime_unknown
                        routingClassification: real-time
                        messageReference: 120ef864-3e6b-423f-a8cb-307a3fc6d6af
        "400":
          description: Bad request (the request is not well-formed).
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Bad Request:
                  summary: Error - Bad Request
                  description: >
                    The request could not be processed. When available, the error response contains additional details.
                  value:
                    version: 2
                    httpStatusCode: 400
                    message: Bad Request
                    details: The request body could not be processed.
        "403":
          description: The request is forbidden because the license is not active.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Forbidden:
                  summary: Error - Forbidden
                  description: The request is forbidden because the license is not active.
                  value:
                    version: 2
                    httpStatusCode: 403
                    message: Forbidden
                    details: A license is required to use SAS Real-Time Watchlist Screening for Entities. Contact your SAS representative for more information.
        "404":
          $ref: "#/paths/~1/get/responses/404"
        "406":
          description: Not Acceptable. Include an Accept header with a supported value on the request.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Not Acceptable:
                  summary: Error - Not Acceptable
                  description: The header field "Accept" does not have a supported value.
                  value:
                    version: 2
                    httpStatusCode: 406
                    message: Not Acceptable Error
        "408":
          description: Request timeout.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Request timeout:
                  summary: Error - Request timeout
                  description: The request took too long to generate a response.
                  value:
                    version: 2
                    httpStatusCode: 408
                    message: Request timeout
        "415":
          description: Unsupported Media Type. Include a Content-Type header with a supported value in the request.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Unsupported Media Type:
                  summary: Error - Unsupported Media Type
                  description: The header field "Content-Type" does not have a supported value.
                  value:
                    version: 2
                    httpStatusCode: 415
                    message: Unsupported Media Type
        "502":
          description: Bad Gateway
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Bad Gateway:
                  summary: Error - Bad Gateway
                  description: Bad Gateway.
                  value:
                    version: 2
                    httpStatusCode: 502
                    message: Bad Gateway
                    details: Error details.
        "503":
          description: Service Unavailable
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Service Unavailable:
                  summary: Error - Service Unavailable
                  description: Service Unavailable.
                  value:
                    version: 2
                    httpStatusCode: 503
                    message: Service Unavailable
                    errors:
                      version: 2
                      httpStatusCode: 404
                      message: Not Found
                      details: https://demo.neterium.cloud/api/v1/core/presets
  "/entity/{partyId}/resolutions":
    post:
      operationId: createResolution
      summary: Record a resolution for a screening hit
      description: Records the resolution of a screening hit for an entity profile.
      tags:
        - Screening
      parameters:
        - $ref: "#/paths/~1entity~1%7BpartyId%7D/get/parameters/0"
      requestBody:
        description: A record describing the resolution.
        required: true
        content:
          application/vnd.sas.watchlist.screening.resolution+json:
            schema:
              $ref: "#/components/schemas/screeningResolution"
            examples:
              Screening Request:
                $ref: "#/paths/~1entity~1%7BpartyId%7D~1resolutions/post/requestBody/content/application~1json/examples/Screening%20Request"
          application/json:
            schema:
              $ref: "#/components/schemas/screeningResolution"
            examples:
              Screening Request:
                summary: Resolution
                description: Example of a resolution for a screening hit. Note that the modification and reviewed properties are computed by the downstream alert management system.
                value:
                  messageReference: 317afc87-6240-480a-b58c-4732539eabe7
                  profileId: OFAC000000018400
                  resolutionName: False Positive
                  comment: This is OK
                  productivity: full
                  action: none
                  sendForReview: false
                  triggerException: true
                  modifiedBy: bobby
                  modifiedDttm: 2025-12-16T07:48:05.688Z
                  reviewedBy: jimmy
                  reviewedDttm: 2025-12-16T07:48:05.688Z
                  matchFinalized: true
      responses:
        "201":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.watchlist.screening.resolution+json:
              schema:
                $ref: "#/components/schemas/screeningResolution"
              examples:
                Screening Response:
                  $ref: "#/paths/~1entity~1%7BpartyId%7D~1resolutions/post/responses/201/content/application~1json/examples/Screening%20Response"
            application/json:
              schema:
                $ref: "#/components/schemas/screeningResolution"
              examples:
                Screening Response:
                  summary: Resolution response
                  description: Example of a resolution response.
                  value:
                    messageReference: 317afc87-6240-480a-b58c-4732539eabe7
                    profileId: OFAC000000018400
                    resolutionName: False Positive
                    comment: This is OK
                    productivity: full
                    action: none
                    sendForReview: false
                    triggerException: true
                    modifiedBy: bobby
                    modifiedDttm: 2025-12-16T07:48:05.688Z
                    reviewedBy: jimmy
                    reviewedDttm: 2025-12-16T07:48:05.688Z
                    matchFinalized: true
                    links:
                      - href: /watchlistScreening/entity/00001
                        method: GET
                        rel: entity
                        type: application/json
                        uri: /watchlistScreening/entity/00001
        "400":
          $ref: "#/paths/~1entity/post/responses/400"
        "404":
          $ref: "#/paths/~1/get/responses/404"
        "406":
          $ref: "#/paths/~1entity/post/responses/406"
        "415":
          $ref: "#/paths/~1entity/post/responses/415"
  /payment:
    post:
      operationId: screenPayment
      summary: Screen a group of payments
      description: Performs a screening action on a list of payments.
      tags:
        - Screening
      requestBody:
        description: A collection of payments to be screened and the options to use for this screening request.
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/paymentScreening"
            examples:
              Screening Request:
                summary: Payment Screening Request
                description: An payment screening request with a single payment.
                value:
                  message:
                    payment:
                      - identifier: "80958"
                        dataSource: SWIFT
                        transactionId: TXN44611
                        currency: UYU
                        amount: 707766.03
                        transactionDttm: 2021-04-23T12:00:00Z
                        debtor:
                          firstName: Habib
                          surname: Soussou
                          postalAddress:
                            - countryCode: CF
                        debtorAgent:
                          identity:
                            - type: BIC
                              number: ZHFZGB7Z
                        creditor:
                          name: Carlos Hawkins
                        creditorAgent:
                          identity:
                            - type: BIC
                              number: HNEEGBAG
                        ultimateCreditor:
                          name: Matthew Moore
                          postalAddress:
                            - countryCode: CF
                        intermediaries:
                          - identity:
                              - type: BIC
                                number: RCDFIQBA
                          - identity:
                              - type: BIC
                                number: JTBHGB6J
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/paymentScreening"
              examples:
                Screening Response:
                  summary: Payment Screening Response
                  description: A payment screening response with a single payment.
                  value:
                    message:
                      payment:
                        - amount: 707766.03
                          creditor:
                            name: Carlos Hawkins
                            screeningResult:
                              discardedHits: 0
                              hits: 0
                              messageReference: c3880c31-7013-43ca-9a75-c1f10caaa8de
                              statusCode: Success
                          creditorAgent:
                            identity:
                              - number: HNEEGBAG
                                type: BIC
                            screeningResult:
                              discardedHits: 0
                              hits: 0
                              messageReference: c3880c31-7013-43ca-9a75-c1f10caaa8de
                              statusCode: Success
                          currency: UYU
                          dataSource: SWIFT
                          debtor:
                            firstName: Habib
                            postalAddress:
                              - countryCode: CF
                            screeningResult:
                              discardedHits: 1
                              hits: 4
                              matchedProfile:
                                - categories:
                                    - CAF
                                  checksum: -327052795
                                  coreChecksum: -718590065
                                  dateOfBirth:
                                    - birthDay: 13
                                      birthDt: 1980-03-13
                                      birthMonth: 3
                                      birthYear: 1980
                                  geoScore: 0
                                  level: medium
                                  links:
                                    - method: GET
                                      rel: profile
                                      href: /watchlistScreening/profiles/EU00000000106138?checksum=-327052795
                                      uri: /watchlistScreening/profiles/EU00000000106138?checksum=-327052795
                                      type: application/json
                                  locationFrom: 0
                                  locationPath: /debtor/name
                                  locationTo: 13
                                  matchType: /name/alias
                                  matchedName: Soussou, Habib
                                  primaryName: Soussou Abib
                                  profileBirthPlaces:
                                    - city: ""
                                      countryCode: cf
                                  profileId: EU00000000106138
                                  profileIds:
                                    - "23672198628"
                                  profileLastUpdated: 2025-09-08T01:10:06.925Z
                                  profilePlaces:
                                    - city: Boda
                                      countryCode: cf
                                  profileRelatedCountries:
                                    - cf
                                  profileStatus: UNK
                                  profileType: individual
                                  sanctions:
                                    - EU
                                  score: 100
                                  scoreScope:
                                    - COUNTRY
                                    - NAME
                                  screened: Soussou, Habib
                                  tags:
                                    - SAN
                                - categories:
                                    - Central African Republic
                                  checksum: -1727466793
                                  coreChecksum: -2056675719
                                  dateOfBirth:
                                    - birthDay: 13
                                      birthDt: 1980-03-13
                                      birthMonth: 3
                                      birthYear: 1980
                                  geoScore: 0
                                  level: medium
                                  links:
                                    - method: GET
                                      rel: profile
                                      href: /watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793
                                      uri: /watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793
                                      type: application/json
                                  locationFrom: 0
                                  locationPath: /debtor/name
                                  locationTo: 13
                                  matchType: /name/primary
                                  matchedName: Soussou, Habib
                                  primaryName: Soussou, Habib
                                  profileBirthPlaces:
                                    - city: ""
                                      countryCode: cf
                                  profileId: HMT0000000013272
                                  profileLastUpdated: 2025-09-08T01:15:00.568Z
                                  profilePlaces:
                                    - city: Boda
                                      countryCode: cf
                                  profileRelatedCountries:
                                    - cf
                                  profileStatus: UNK
                                  profileType: individual
                                  sanctions:
                                    - HMT
                                  score: 100
                                  scoreScope:
                                    - COUNTRY
                                    - NAME
                                  screened: Soussou, Habib
                                  tags:
                                    - SAN
                                - categories:
                                    - CAR
                                  checksum: -1871588783
                                  coreChecksum: -662103456
                                  dateOfBirth:
                                    - birthDay: 13
                                      birthDt: 1980-03-13
                                      birthMonth: 3
                                      birthYear: 1980
                                  exceptionId: 0f43c2d2-4c9c-48ac-8814-ab2d435fef87
                                  exceptionReference: CE_2c59e01d-5ed7-427d-a153-f304a0f2d899
                                  geoScore: 0
                                  level: discarded
                                  links:
                                    - method: GET
                                      rel: profile
                                      href: /watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783
                                      uri: /watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783
                                      type: application/json
                                    - method: GET
                                      rel: exception
                                      href: /watchlistScreening/exceptions/0f43c2d2-4c9c-48ac-8814-ab2d435fef87
                                      uri: /watchlistScreening/exceptions/0f43c2d2-4c9c-48ac-8814-ab2d435fef87
                                      type: application/vnd.sas.watchlist.screening.conditional.exception
                                  locationFrom: 0
                                  locationPath: /debtor/name
                                  locationTo: 13
                                  matchType: /name/primary
                                  matchedName: Soussou, Habib
                                  mediaAgeScore: 0
                                  mediaQuantityScore: 0
                                  primaryName: Soussou, Habib
                                  profileId: OFAC000000018428
                                  profileLastUpdated: 2025-09-08T01:25:06.154Z
                                  profilePlaces:
                                    - city: Boda
                                      countryCode: cf
                                  profileRelatedCountries:
                                    - cf
                                  profileStatus: UNK
                                  profileType: individual
                                  proximityScore: 100
                                  sanctions:
                                    - OFACSD
                                  score: 100
                                  scoreScope:
                                    - COUNTRY
                                    - NAME
                                  screened: Soussou, Habib
                                  tags:
                                    - SAN
                                - categories:
                                    - CAR
                                  checksum: -706261789
                                  coreChecksum: 770033445
                                  dateOfBirth:
                                    - birthDay: 13
                                      birthDt: 1980-03-13
                                      birthMonth: 3
                                      birthYear: 1980
                                  geoScore: 0
                                  level: medium
                                  links:
                                    - method: GET
                                      rel: profile
                                      href: /watchlistScreening/profiles/UN00000006908465?checksum=-706261789
                                      uri: /watchlistScreening/profiles/UN00000006908465?checksum=-706261789
                                      type: application/json
                                  locationFrom: 0
                                  locationPath: /debtor/name
                                  locationTo: 13
                                  matchType: /name/primary
                                  matchedName: Soussou, Habib
                                  primaryName: Soussou, Habib
                                  profileBirthPlaces:
                                    - city: ""
                                      countryCode: cf
                                  profileId: UN00000006908465
                                  profileIds:
                                    - UNCFI005
                                  profileLastUpdated: 2025-09-08T01:05:01.359Z
                                  profilePlaces:
                                    - city: ""
                                      countryCode: cf
                                  profileRelatedCountries:
                                    - cf
                                  profileStatus: UNK
                                  profileType: individual
                                  sanctions:
                                    - UN
                                  score: 100
                                  scoreScope:
                                    - COUNTRY
                                    - NAME
                                  screened: Soussou, Habib
                                  tags:
                                    - SAN
                              messageReference: c3880c31-7013-43ca-9a75-c1f10caaa8de
                              statusCode: Success
                            surname: Soussou
                          debtorAgent:
                            identity:
                              - number: ZHFZGB7Z
                                type: BIC
                            screeningResult:
                              discardedHits: 0
                              hits: 0
                              messageReference: c3880c31-7013-43ca-9a75-c1f10caaa8de
                              statusCode: Success
                          identifier: "80958"
                          intermediaries:
                            - identity:
                                - number: RCDFIQBA
                                  type: BIC
                              screeningResult:
                                discardedHits: 0
                                hits: 1
                                matchedProfile:
                                  - categories:
                                      - IRAN
                                      - IRAN-EO13902
                                    checksum: -1345815218
                                    coreChecksum: -971362320
                                    geoScore: 0
                                    level: low
                                    links:
                                      - method: GET
                                        rel: profile
                                        href: /watchlistScreening/profiles/OFAC000000013146?checksum=-1345815218
                                        uri: /watchlistScreening/profiles/OFAC000000013146?checksum=-1345815218
                                        type: application/json
                                    locationFrom: 0
                                    locationPath: /intermediaries[0]/ids[0]/value
                                    locationTo: 7
                                    matchType: /id/bic
                                    matchedName: RCDFIQBA
                                    mediaAgeScore: 0
                                    mediaQuantityScore: 0
                                    primaryName: Islamic Regional Cooperation Bank
                                    profileId: OFAC000000013146
                                    profileIds:
                                      - RCDFIQBA
                                    profileLastUpdated: 2025-09-08T01:25:06.154Z
                                    profilePlaces:
                                      - city: Baghdad
                                        countryCode: iq
                                      - city: Tehran
                                        countryCode: ir
                                      - city: Baghdad
                                        countryCode: iq
                                      - city: Baghdad
                                        countryCode: iq
                                    profileRelatedCountries:
                                      - ir
                                    profileStatus: UNK
                                    profileType: entity
                                    proximityScore: 100
                                    sanctions:
                                      - OFACSD
                                    score: 100
                                    scoreScope:
                                      - NAME
                                    screened: RCDFIQBA
                                    tags:
                                      - SAN
                                messageReference: c3880c31-7013-43ca-9a75-c1f10caaa8de
                                statusCode: Success
                            - identity:
                                - number: JTBHGB6J
                                  type: BIC
                              screeningResult:
                                discardedHits: 0
                                hits: 0
                                messageReference: c3880c31-7013-43ca-9a75-c1f10caaa8de
                                statusCode: Success
                          screeningResult:
                            discardedHits: 1
                            hits: 5
                            messageReference: c3880c31-7013-43ca-9a75-c1f10caaa8de
                            remainingHits: 4
                            statusCode: Success
                          transactionDttm: 2021-04-23T12:00:00Z
                          transactionId: TXN44611
                          ultimateCreditor:
                            name: Matthew Moore
                            postalAddress:
                              - countryCode: CF
                            screeningResult:
                              discardedHits: 0
                              hits: 0
                              messageReference: c3880c31-7013-43ca-9a75-c1f10caaa8de
                              statusCode: Success
                      screeningOptions:
                        chnPayment: dev_chn_payment
                        messageReference: c3880c31-7013-43ca-9a75-c1f10caaa8de
                        routingClassification: real-time
        "400":
          $ref: "#/paths/~1entity/post/responses/400"
        "403":
          description: The request is forbidden because the license is not active.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Forbidden:
                  summary: Error - Forbidden
                  description: The request is forbidden because the license is not active.
                  value:
                    version: 2
                    httpStatusCode: 403
                    message: Forbidden
                    details: A license is required to use SAS Real-Time Watchlist Screening for Payments. Contact your SAS representative for more information.
        "404":
          $ref: "#/paths/~1/get/responses/404"
        "406":
          $ref: "#/paths/~1entity/post/responses/406"
        "408":
          $ref: "#/paths/~1entity/post/responses/408"
        "415":
          $ref: "#/paths/~1entity/post/responses/415"
        "502":
          $ref: "#/paths/~1entity/post/responses/502"
        "503":
          $ref: "#/paths/~1entity/post/responses/503"
  "/entity/{partyId}":
    get:
      operationId: getScreenedEntity
      summary: Get a screened entity by its party identifier
      description: Returns the requested screened entity data. This data is the latest screened data that is associated with the specified entity.
      tags:
        - Screening
      parameters:
        - name: partyId
          required: true
          description: The party identifier of the screened entity.
          in: path
          schema:
            type: string
            minLength: 5
            maxLength: 100
        - name: Accept
          in: header
          description: The desired representation for the response.
          schema:
            type: string
            enum:
              - application/json
            default: application/json
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/json:
              schema:
                title: Screened Entity
                description: The screened data returned for an entity that is associated with a specific screening request.
                type: object
                properties:
                  processingTimestamp:
                    title: Processing Timestamp
                    description: The timestamp at which the entity screening data is generated.
                    type: string
                    minLength: 19
                    maxLength: 27
                    readOnly: true
                  links:
                    type: array
                    description: The links that apply to the object. This value is ignored on input.
                    items:
                      $ref: "#/components/schemas/preset/properties/links/items"
                    readOnly: true
                  party:
                    allOf:
                      - title: Screened Entity Response
                        description: The response data resulting from the latest screening of the entity.
                        type: object
                        readOnly: true
                      - $ref: "#/components/schemas/entityScreening/properties/message/properties/party/items"
              examples:
                Screened Entity:
                  summary: Screened Entity Response
                  description: The latest screened entity data response that is associated with an entity.
                  value:
                    processingTimestamp: 2025-01-18T19:19:27.849403Z
                    links:
                      - href: /watchlistScreening/entity/00001
                        method: GET
                        rel: self
                        type: application/json
                        uri: /watchlistScreening/entity/00001
                    party:
                      dateofbirth:
                        - birthDay: 3
                          birthDt: 1960-03-13
                          birthYear: 1960
                        - birthDay: 13
                          birthMonth: 3
                          birthYear: 1962
                      firstName: Oscar Heath
                      gender: male
                      identifier: "00001"
                      identity:
                        - countryOfIssue: 840
                          number: "00001"
                      incomeStatusType: UHW
                      language: 840
                      languageCode: USA
                      address:
                        - category: pob
                          city: white pines bay
                          countryCode: us
                      name: Ashworth, Oscar Heath
                      screeningResult:
                        discardedHits: 0
                        hits: 2
                        remainingHits: 2
                        matchedProfile:
                          - alert:
                              comment: sanctions alert generated on SAN match
                              screeningOutcome: Alerted
                            categories:
                              - (Cat 1) Special Interest Person (SIP)
                              - (Cat 2) Other Official Lists
                              - (Cat 2) Sanctions Lists
                            checksum: -1727466793
                            coreChecksum: -2056675719
                            dateOfBirth:
                              - birthDay: 13
                                birthDt: 1960-03-13
                                birthMonth: 3
                                birthYear: 1960
                            exceptionId: 665ac66a-7960-498e-aaf5-0c4a6e2d188b
                            level: discarded
                            links:
                              - method: GET
                                rel: profile
                                href: /watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793
                                uri: /watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793
                                type: application/json
                              - method: GET
                                rel: exception
                                href: /watchlistScreening/exceptions/665ac66a-7960-498e-aaf5-0c4a6e2d188b
                                uri: /watchlistScreening/exceptions/665ac66a-7960-498e-aaf5-0c4a6e2d188b
                                type: application/vnd.sas.watchlist.screening.conditional.exception
                            matchType: /name/primary
                            matchedName: Ashworth, Oscar Heath
                            primaryName: Ashworth, Oscar Heath
                            profileBirthPlaces:
                              - city: phoenix
                                countryCode: us
                            profileId: HMT0000000013272
                            profileLastUpdated: 2024-02-20T01:00:01.163Z
                            profilePlaces:
                              - city: Pine Bay
                                countryCode: us
                            profileGender: male
                            profileRelatedCountries:
                              - us
                            profileStatus: UNK
                            profileType: individual
                            sanctions:
                              - HMT
                            score: 98
                            scoreScope:
                              - COUNTRY
                              - DOB
                              - NAME
                            screened: Ashworth, Oscar Heath
                            tags:
                              - SAN
                          - alert:
                              comment: sanctions alert generated on SAN match
                              screeningOutcome: Alerted
                            categories:
                              - MUR
                            checksum: -1871588783
                            coreChecksum: -662103456
                            dateOfBirth:
                              - birthDay: 13
                                birthDt: 1960-03-13
                                birthMonth: 3
                                birthYear: 1960
                            level: medium
                            links:
                              - method: GET
                                rel: profile
                                href: /watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783
                                uri: /watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783
                                type: application/json
                            matchType: /name/alias
                            matchedName: Ashworth, Heath
                            primaryName: Ashworth, Oscar
                            profileId: OFAC000000018428
                            profileLastUpdated: 2024-02-20T01:15:01.163Z
                            profilePlaces:
                              - city: Pine Bay
                                countryCode: us
                            profileRelatedCountries:
                              - us
                            profileStatus: UNK
                            profileType: individual
                            proximityScore: 100
                            sanctions:
                              - OFACSD
                            score: 98
                            scoreScope:
                              - COUNTRY
                              - DOB
                              - NAME
                            screened: Ashworth, Oscar Heath
                            tags:
                              - SAN
                        messageReference: 9e5242c1-a55e-47ec-8078-625938f05dd9
                        statusCode: Success
                      surname: Ashworth
                      type: individual
                      vipFlg: false
        "400":
          description: Bad request (the request is not well-formed).
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Bad Request:
                  summary: Error - Bad Request
                  description: >
                    The request could not be processed. When available, the error response contains additional details.
                  value:
                    version: 2
                    httpStatusCode: 400
                    message: Bad Request
                    details: 'Could not process the request with the parameters: partyId = "0000"'
        "404":
          description: The specified resource was not found.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Not Found:
                  summary: Error - Not Found
                  description: The specified resource was not found.
                  value:
                    version: 2
                    httpStatusCode: 404
                    message: Not Found
                    details: 'No entity was found with the identifier: "UNK00001"'
        "406":
          $ref: "#/paths/~1entity/post/responses/406"
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
  /presets:
    get:
      operationId: getPresets
      summary: Get a list of presets
      description: >
        Returns a list of presets.
      tags:
        - Presets
      parameters:
        - name: Accept
          in: header
          description: The desired representation for the response.
          schema:
            type: string
            enum:
              - application/vnd.sas.collection+json
              - application/json
            default: application/vnd.sas.collection+json
        - name: Accept-Item
          description: The desired item representation for collections; the default is application/json, which returns both channels and presets in the response.
          in: header
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.preset+json
              - application/vnd.sas.watchlist.screening.preset+json;version=1
              - application/vnd.sas.watchlist.screening.channel+json
              - application/vnd.sas.watchlist.screening.channel+json;version=1
              - application/json
            default: application/json
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.collection+json:
              schema:
                $ref: "#/components/schemas/presetCollection"
              examples:
                Preset Collection:
                  $ref: "#/paths/~1presets/get/responses/200/content/application~1json/examples/Preset%20Collection"
            application/json:
              schema:
                $ref: "#/components/schemas/presetCollection"
              examples:
                Preset Collection:
                  summary: Preset Collection
                  description: A collection of presets.
                  value:
                    version: 2
                    accept: application/vnd.sas.watchist.screening.preset
                    count: 1
                    start: 0
                    limit: 1
                    name: presets
                    links:
                      - method: GET
                        rel: self
                        href: /watchlistScreening/presets
                        uri: /watchlistScreening/presets
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.preset
                      - method: POST
                        rel: create
                        href: /watchlistScreening/presets
                        uri: /watchlistScreening/presets
                        type: application/vnd.sas.watchlist.screening.preset
                        responseType: application/vnd.sas.watchlist.screening.preset
                    items:
                      - id: ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
                        name: preset_example
                        options:
                          threshold: 85
                          metaScore: true
                          matching: fuzzy
                          recordType: individual
                          geoScore: false
                          geoThreshold: 0
                          bicThreshold: 100
                          lowQualityAliases: none
                          dobMatching: year
                          dobPrecision: 0
                          dobPolicy:
                            value: required
                            match: required
                            level: low
                          genderPolicy:
                            value: required
                            match: required
                            level: low
                          idPolicy:
                            value: required
                            match: required
                            level: low
                          idPrecision: 5
                          tags:
                            - SAN
                          categories:
                            - PROFILE_CATEGORY
                          sanctionCountries:
                            - US
                            - GB
                          sanctions:
                            - SANCTION_CODE
                          matchTypes:
                            - /name/primary
                          cityProximity: 50
                          cityPolicy:
                            value: required
                            match: required
                            level: low
                          countryPolicy:
                            value: required
                            match: required
                            level: low
                          charset: latin
                          affinity: def
                          riskCountries:
                            - string
                          riskRegions:
                            - Centre/cm
                            - Wisconsin
                          status: any
                          inactiveDays: 0
                          pepLevel: intl
                          tweaks:
                            detectTitle: false
                            detectBicCodes: true
                            useTextPlaces: false
                            surnameAbbreviations: false
                            perfectSmallNames: false
                            bidirectionalMatching: false
                            deepIndexSearch: false
                            lowQualityNicknames: false
                            partialIndividualNames: NONE
                            partialIndividualNamePatterns:
                              - 1,1
                            partialEntityNames: NONE
                            longAbbreviations: false
                            minTextMatchLength: 0
                            globalLegalForms: false
                          exclusions:
                            - string
                          fieldPresets:
                            debtor: my-preset1
                          detectStripping: false
                          detectDuplicates: false
                        creationTimeStamp: 2023-08-31T13:56:49.021Z
                        modifiedTimeStamp: 2023-08-31T13:56:57.596Z
                        version: 1
                        links:
                          - method: GET
                            rel: up
                            href: /watchlistScreening/presets
                            uri: /watchlistScreening/presets
                            type: application/vnd.sas.collection
                            itemType: application/vnd.sas.watchlist.screening.preset
                          - method: GET
                            rel: self
                            href: watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
                            uri: watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
                            type: application/vnd.sas.watchlist.screening.preset
                          - method: PUT
                            rel: update
                            href: watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
                            uri: watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
                            type: application/vnd.sas.watchlist.screening.preset
                            responseType: application/vnd.sas.watchlist.screening.preset
                          - method: DELETE
                            rel: delete
                            href: watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
                            uri: watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
        "400":
          $ref: "#/paths/~1entity/post/responses/400"
        "404":
          $ref: "#/paths/~1/get/responses/404"
        "406":
          description: Not Acceptable. Include an Accept/Accept-Item header with a supported value on the request.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Not Acceptable:
                  description: The header field "Accept" or "Accept-Item" does not have a supported value.
                  value:
                    version: 2
                    httpStatusCode: 406
                    message: Not Acceptable Error
        "500":
          description: The service encountered an error.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Internal Server Error:
                  summary: Error - Internal Server Error
                  description: The service encountered an error.
                  value:
                    version: 2
                    httpStatusCode: 500
                    message: Internal Server Error
                    details: The service encountered an error.
        "502":
          description: Unable to contact Neterium or a generic bad gateway error.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Unable to Contact Neterium:
                  summary: Error - Unable to contact Neterium
                  description: Unable to contact Neterium.
                  value:
                    version: 2
                    httpStatusCode: 502
                    message: Unable to contact Neterium.
                    details: Error Details.
                Error - Bad Gateway:
                  $ref: "#/paths/~1entity/post/responses/502/content/application~1vnd.sas.error%2Bjson/examples/Error%20-%20Bad%20Gateway"
    post:
      operationId: createPreset
      summary: Create a new preset
      description: Creates a new custom preset
      tags:
        - Presets
      parameters:
        - name: Content-Type
          in: header
          description: The representation for the request.
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.preset+json
              - application/vnd.sas.watchlist.screening.preset+json;version=1
              - application/vnd.sas.watchlist.screening.channel+json
              - application/vnd.sas.watchlist.screening.channel+json;version=1
              - application/json
            default: application/vnd.sas.watchlist.screening.preset+json
        - name: Accept
          in: header
          description: The desired representation for the response.
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.preset+json
              - application/vnd.sas.watchlist.screening.preset+json;version=1
              - application/vnd.sas.watchlist.screening.channel+json
              - application/vnd.sas.watchlist.screening.channel+json;version=1
              - application/json
            default: application/vnd.sas.watchlist.screening.preset+json
      requestBody:
        description: The preset to create.
        required: true
        content:
          application/vnd.sas.watchlist.screening.preset+json:
            schema:
              $ref: "#/components/schemas/preset"
            examples:
              Preset:
                $ref: "#/paths/~1presets/post/requestBody/content/application~1json/examples/Preset"
          application/vnd.sas.watchlist.screening.channel+json:
            schema:
              $ref: "#/components/schemas/channel"
            examples:
              Channel:
                summary: Channel
                description: Example of a channel. Note that the name and preset fields will be augmented with the client reference automatically. For example, given a client reference of 'sample', the preset name is changed to 'sample_chn_realtime_individual' and the individual presets become 'sample_prv', 'sample_san', et cetera.
                value:
                  name: chn_realtime_individual
                  version: 1
                  options:
                    tags:
                      - "!AM"
                      - "!VSL"
                      - "!AIR"
                      - "!LOC"
                    tagPresets:
                      - tag: PRV
                        preset: prv
                      - tag: SAN
                        preset: san
                      - tag: OOL
                        preset: ool
                      - tag: PEP
                        preset: pep
                      - tag: RCA
                        preset: rca
                      - tag: SIE
                        preset: sie
                      - tag: SIP
                        preset: sip
                      - tag: SOC
                        preset: soc
          application/json:
            schema:
              $ref: "#/components/schemas/preset"
            examples:
              Preset:
                summary: Preset
                description: Example of a preset.
                value:
                  name: preset_example
                  options:
                    threshold: 85
                    matching: fuzzy
                    recordType: individual
                    geoScore: false
                    geoThreshold: 0
                    bicThreshold: 100
                    lowQualityAliases: none
                    dobMatching: year
                    dobPrecision: 0
                    dobPolicy:
                      value: required
                      match: required
                      level: low
                    genderPolicy:
                      value: required
                      match: required
                      level: low
                    idPolicy:
                      value: required
                      match: required
                      level: low
                    idPrecision: 5
                    tags:
                      - SAN
                    categories:
                      - PROFILE_CATEGORY
                    sanctionCountries:
                      - US
                      - GB
                    sanctions:
                      - SANCTION_CODE
                    matchTypes:
                      - /name/primary
                    cityProximity: 50
                    cityPolicy:
                      value: required
                      match: required
                      level: low
                    countryPolicy:
                      value: required
                      match: required
                      level: low
                    charset: latin
                    affinity: def
                    riskCountries:
                      - string
                    riskRegions:
                      - Centre/cm
                      - "Wisconsin "
                    status: any
                    inactiveDays: 0
                    pepLevel: intl
                    tweaks:
                      detectTitle: false
                      detectBicCodes: true
                      useTextPlaces: false
                      surnameAbbreviations: false
                      perfectSmallNames: false
                      bidirectionalMatching: false
                      deepIndexSearch: false
                      lowQualityNicknames: false
                      partialIndividualNames: NONE
                      partialIndividualNamePatterns:
                        - 1,1
                      partialEntityNames: NONE
                      longAbbreviations: false
                      minTextMatchLength: 0
                      globalLegalForms: false
                    exclusions:
                      - string
                    fieldPresets:
                      debtor: my-preset1
      responses:
        "201":
          description: The new preset was created.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
            Location:
              description: The location of the created object.
              schema:
                type: string
          content:
            application/vnd.sas.watchlist.screening.preset+json:
              schema:
                $ref: "#/components/schemas/preset"
              examples:
                Preset created:
                  $ref: "#/paths/~1presets/post/responses/201/content/application~1json/examples/Preset%20created"
            application/vnd.sas.watchlist.screening.channel+json:
              schema:
                $ref: "#/components/schemas/channel"
              examples:
                Channel created:
                  summary: Channel
                  description: A channel response structure.
                  value:
                    id: 635e9f25-fe79-428d-a606-93a659ad9888
                    name: sample_chn_realtime_individual
                    creationTimeStamp: 2023-09-29T16:15:15.631Z
                    modifiedTimeStamp: 2023-09-29T16:15:15.631Z
                    version: 1
                    links:
                      - method: GET
                        rel: up
                        href: /watchlistScreening/presets
                        uri: /watchlistScreening/presets
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.preset
                      - method: GET
                        rel: self
                        href: /watchlistScreening/presets/635e9f25-fe79-428d-a606-93a659ad9888
                        uri: /watchlistScreening/presets/635e9f25-fe79-428d-a606-93a659ad9888
                        type: application/vnd.sas.watchlist.screening.channel
                      - method: PUT
                        rel: update
                        href: /watchlistScreening/presets/635e9f25-fe79-428d-a606-93a659ad9888
                        uri: /watchlistScreening/presets/635e9f25-fe79-428d-a606-93a659ad9888
                        type: application/vnd.sas.watchlist.screening.channel
                        responseType: application/vnd.sas.watchlist.screening.channel
                      - method: DELETE
                        rel: delete
                        href: /watchlistScreening/presets/635e9f25-fe79-428d-a606-93a659ad9888
                        uri: /watchlistScreening/presets/635e9f25-fe79-428d-a606-93a659ad9888
                    options:
                      tags:
                        - "!AM"
                        - "!VSL"
                        - "!AIR"
                        - "!LOC"
                      tagPresets:
                        - tag: PRV
                          preset: sample_prv
                        - tag: SAN
                          preset: sample_san
                        - tag: OOL
                          preset: sample_ool
                        - tag: PEP
                          preset: sample_pep
                        - tag: RCA
                          preset: sample_rca
                        - tag: SIE
                          preset: sample_sie
                        - tag: SIP
                          preset: sample_sip
                        - tag: SOC
                          preset: sample_soc
            application/json:
              schema:
                $ref: "#/components/schemas/preset"
              examples:
                Preset created:
                  summary: Preset
                  description: A preset response structure.
                  value:
                    id: ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
                    name: preset_example
                    options:
                      threshold: 85
                      metaScore: true
                      matching: fuzzy
                      recordType: individual
                      geoScore: false
                      geoThreshold: 0
                      bicThreshold: 100
                      lowQualityAliases: none
                      dobMatching: year
                      dobPrecision: 0
                      dobPolicy:
                        value: required
                        match: required
                        level: low
                      genderPolicy:
                        value: required
                        match: required
                        level: low
                      idPolicy:
                        value: required
                        match: required
                        level: low
                      idPrecision: 5
                      tags:
                        - SAN
                      categories:
                        - PROFILE_CATEGORY
                      sanctionCountries:
                        - US
                        - GB
                      sanctions:
                        - SANCTION_CODE
                      matchTypes:
                        - /name/primary
                      cityProximity: 50
                      cityPolicy:
                        value: required
                        match: required
                        level: low
                      countryPolicy:
                        value: required
                        match: required
                        level: low
                      charset: latin
                      affinity: def
                      riskCountries:
                        - string
                      riskRegions:
                        - Centre/cm
                        - "Wisconsin "
                      status: any
                      inactiveDays: 0
                      pepLevel: intl
                      tweaks:
                        detectTitle: false
                        detectBicCodes: true
                        useTextPlaces: false
                        surnameAbbreviations: false
                        perfectSmallNames: false
                        bidirectionalMatching: false
                        deepIndexSearch: false
                        lowQualityNicknames: false
                        partialIndividualNames: NONE
                        partialIndividualNamePatterns:
                          - 1,1
                        partialEntityNames: NONE
                        longAbbreviations: false
                        minTextMatchLength: 0
                        globalLegalForms: false
                      exclusions:
                        - string
                      fieldPresets:
                        debtor: my-preset1
                      detectStripping: false
                      detectDuplicates: false
                    creationTimeStamp: 2023-08-31T13:56:49.021Z
                    modifiedTimeStamp: 2023-08-31T13:56:57.596Z
                    version: 1
                    links:
                      - method: GET
                        rel: up
                        href: /watchlistScreening/presets
                        uri: /watchlistScreening/presets
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.preset
                      - method: GET
                        rel: self
                        href: /watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
                        uri: /watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
                        type: application/vnd.sas.watchlist.screening.preset
                      - method: PUT
                        rel: update
                        href: /watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
                        uri: /watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
                        type: application/vnd.sas.watchlist.screening.preset
                        responseType: application/vnd.sas.watchlist.screening.preset
                      - method: DELETE
                        rel: delete
                        href: /watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
                        uri: /watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a
        "400":
          $ref: "#/paths/~1entity/post/responses/400"
        "404":
          $ref: "#/paths/~1/get/responses/404"
        "409":
          description: Resource Conflict. The request cannot be completed due to a conflict with the current state of the target resource.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Resource Conflict:
                  description: The header field "Accept" or "Accept-Item" does not have a supported value.
                  value:
                    version: 2
                    httpStatusCode: 409
                    message: Conflict
                    details: >
                      "outcome": "error",

                      "errorCode": 40900,

                      "errorMessage": "Resource conflict",

                      "errorDetails": "A record with the same name already exists."
        "502":
          $ref: "#/paths/~1presets/get/responses/502"
  "/presets/{presetId}":
    get:
      operationId: getPreset
      summary: Get a preset by its ID
      description: >
        Returns a preset by its ID.
      tags:
        - Presets
      parameters:
        - $ref: "#/paths/~1presets/post/parameters/1"
        - name: presetId
          required: true
          description: The ID of the preset.
          in: path
          schema:
            type: string
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.watchlist.screening.preset+json:
              schema:
                $ref: "#/components/schemas/preset"
              examples:
                Preset:
                  $ref: "#/paths/~1presets/post/responses/201/content/application~1json/examples/Preset%20created"
            application/vnd.sas.watchlist.screening.channel+json:
              schema:
                $ref: "#/components/schemas/channel"
              examples:
                Channel:
                  $ref: "#/paths/~1presets/post/responses/201/content/application~1vnd.sas.watchlist.screening.channel%2Bjson/examples/Channel%20created"
            application/json:
              schema:
                $ref: "#/components/schemas/preset"
              examples:
                Preset:
                  $ref: "#/paths/~1presets/post/responses/201/content/application~1json/examples/Preset%20created"
        "404":
          description: The specified resource was not found.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Not Found:
                  summary: Error - Not Found
                  description: The specified resource was not found.
                  value:
                    version: 2
                    httpStatusCode: 404
                    message: Not Found
                    details: No object was found with the ID "2b647d99-60f4-4252-adea-8ea2bd35974c".
        "406":
          $ref: "#/paths/~1entity/post/responses/406"
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
        "502":
          $ref: "#/paths/~1presets/get/responses/502"
        "503":
          $ref: "#/paths/~1entity/post/responses/503"
    put:
      operationId: updatePreset
      summary: Update a preset by its ID
      description: Updates the specified preset.
      tags:
        - Presets
      parameters:
        - $ref: "#/paths/~1presets~1%7BpresetId%7D/get/parameters/1"
      requestBody:
        description: The preset to update.
        required: true
        content:
          application/vnd.sas.watchlist.screening.preset+json:
            schema:
              $ref: "#/components/schemas/preset"
            examples:
              Preset:
                $ref: "#/paths/~1presets/post/requestBody/content/application~1json/examples/Preset"
          application/vnd.sas.watchlist.screening.channel+json:
            schema:
              $ref: "#/components/schemas/channel"
            examples:
              Channel:
                $ref: "#/paths/~1presets/post/requestBody/content/application~1vnd.sas.watchlist.screening.channel%2Bjson/examples/Channel"
          application/json:
            schema:
              $ref: "#/components/schemas/preset"
            examples:
              Preset:
                $ref: "#/paths/~1presets/post/requestBody/content/application~1json/examples/Preset"
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.watchlist.screening.preset+json:
              schema:
                $ref: "#/components/schemas/preset"
              examples:
                Preset updated:
                  $ref: "#/paths/~1presets/post/responses/201/content/application~1json/examples/Preset%20created"
            application/vnd.sas.watchlist.screening.channel+json:
              schema:
                $ref: "#/components/schemas/channel"
              examples:
                Channel updated:
                  $ref: "#/paths/~1presets/post/responses/201/content/application~1vnd.sas.watchlist.screening.channel%2Bjson/examples/Channel%20created"
            application/json:
              schema:
                $ref: "#/components/schemas/preset"
              examples:
                Preset updated:
                  $ref: "#/paths/~1presets/post/responses/201/content/application~1json/examples/Preset%20created"
        "400":
          $ref: "#/paths/~1entity/post/responses/400"
        "404":
          $ref: "#/paths/~1presets~1%7BpresetId%7D/get/responses/404"
        "409":
          $ref: "#/paths/~1presets/post/responses/409"
    delete:
      operationId: deletePreset
      summary: Delete a preset by its ID
      description: Deletes the specified preset.
      tags:
        - Presets
      parameters:
        - $ref: "#/paths/~1presets~1%7BpresetId%7D/get/parameters/1"
      responses:
        "204":
          description: The request succeeded.
        "400":
          $ref: "#/paths/~1entity/post/responses/400"
        "401":
          description: Not authenticated.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Unauthorized:
                  summary: Error - Unauthorized
                  description: Unauthorized. This request requires valid authentication.
                  value:
                    version: 2
                    httpStatusCode: 401
                    message: Full authentication is required to access this resource
        "403":
          description: The user does not have permission to complete this request.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Forbidden:
                  summary: Error - Forbidden
                  description: The user does not have permission to complete this request.
                  value:
                    version: 2
                    httpStatusCode: 403
                    message: Forbidden
                    details: Unauthorized
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
  /exceptions:
    get:
      operationId: getScreeningExceptions
      summary: Get a list of screening exceptions
      description: Returns a list of screening exceptions.
      tags:
        - Screening Exceptions
      parameters:
        - $ref: "#/paths/~1presets/get/parameters/0"
        - name: Accept-Item
          description: The desired item representation for collections; the default is application/json, which returns both profile and conditional exceptions in the response.
          in: header
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.conditional.exception+json
              - application/vnd.sas.watchlist.screening.conditional.exception+json;version=1
              - application/vnd.sas.watchlist.screening.profile.exception+json
              - application/vnd.sas.watchlist.screening.profile.exception+json;version=1
              - application/json
            default: application/json
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.collection+json:
              schema:
                $ref: "#/components/schemas/screeningExceptionCollection"
              examples:
                Screening Exception Collection:
                  $ref: "#/paths/~1exceptions/get/responses/200/content/application~1json/examples/Screening%20Exception%20Collection"
            application/json:
              schema:
                $ref: "#/components/schemas/screeningExceptionCollection"
              examples:
                Screening Exception Collection:
                  summary: Screening Exception Collection
                  description: A collection of screening exceptions.
                  value:
                    version: 2
                    accept: application/vnd.sas.watchlist.screening.conditional.exception application/vnd.sas.watchlist.screening.profile.exception
                    count: 1
                    start: 0
                    limit: 1
                    name: screening exceptions
                    links:
                      - method: GET
                        rel: self
                        href: /watchlistScreening/exceptions
                        uri: /watchlistScreening/exceptions
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.profile.exception
                      - method: POST
                        rel: create
                        href: /watchlistScreening/exceptions
                        uri: /watchlistScreening/exceptions
                        type: application/vnd.sas.watchlist.screening.profile.exception
                        responseType: application/vnd.sas.watchlist.screening.profile.exception
                    items:
                      - id: a6490a0c-7a1d-4b0e-9321-0bae3308c889
                        identifier: T2
                        profileId: OFAC000000008124
                        status: ACTIVE
                        creationTimeStamp: 2023-09-29T16:15:15.631Z
                        modifiedTimeStamp: 2023-09-29T16:15:15.631Z
                        version: 1
                        links:
                          - method: GET
                            rel: up
                            href: /watchlistScreening/exceptions
                            uri: /watchlistScreening/exceptions
                            type: application/vnd.sas.collection
                            itemType: application/vnd.sas.watchlist.screening.profile.exception
                          - method: GET
                            rel: self
                            href: /watchlistScreening/exceptions/a6490a0c-7a1d-4b0e-9321-0bae3308c889
                            uri: /watchlistScreening/exceptions/a6490a0c-7a1d-4b0e-9321-0bae3308c889
                            type: application/vnd.sas.watchlist.screening.profile.exception
                          - method: DELETE
                            rel: delete
                            href: /watchlistScreening/exceptions/a6490a0c-7a1d-4b0e-9321-0bae3308c889
                            uri: /watchlistScreening/exceptions/a6490a0c-7a1d-4b0e-9321-0bae3308c889
                      - id: cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
                        expirationType: NEVER
                        conditions:
                          - path: /matchedProfile/tags
                            operator: contains
                            value: VSL
                        status: ACTIVE
                        creationTimeStamp: 2024-01-11T20:46:21.883Z
                        modifiedTimeStamp: 2024-01-11T20:46:21.883Z
                        version: 1
                        links:
                          - method: GET
                            rel: up
                            href: /watchlistScreening/exceptions
                            uri: /watchlistScreening/exceptions
                            type: application/vnd.sas.collection
                            itemType: application/vnd.sas.watchlist.screening.conditional.exception
                          - method: GET
                            rel: self
                            href: /watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
                            uri: /watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
                            type: application/vnd.sas.watchlist.screening.conditional.exception
                          - method: PUT
                            rel: update
                            href: /watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
                            uri: /watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
                            type: application/vnd.sas.watchlist.screening.conditional.exception
                            responseType: application/vnd.sas.watchlist.screening.conditional.exception
                          - method: DELETE
                            rel: delete
                            href: /watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
                            uri: /watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
        "400":
          $ref: "#/paths/~1entity/post/responses/400"
        "404":
          $ref: "#/paths/~1/get/responses/404"
        "406":
          description: Not Acceptable. Include an Accept/Accept-Item header with a supported value on the request.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Accept Header Value Not Acceptable:
                  description: The header field "Accept" or "Accept-Item" does not have a supported value.
                  value:
                    version: 2
                    httpStatusCode: 406
                    message: Not Acceptable Error
                    details:
                      - application/vnd.sas.collection+json
                      - application/vnd.sas.collection+json;version=2
                      - application/json
                Error - Accept-Item Header Value Not Acceptable:
                  description: The header field "Accept" or "Accept-Item" does not have a supported value.
                  value:
                    version: 2
                    httpStatusCode: 406
                    message: Not Acceptable Error
                    details:
                      - application/vnd.sas.watchlist.screening.conditional.exception+json
                      - application/vnd.sas.watchlist.screening.conditional.exception+json;version=1
                      - application/vnd.sas.watchlist.screening.profile.exception+json
                      - application/vnd.sas.watchlist.screening.profile.exception+json;version=1
                      - application/json
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
        "502":
          $ref: "#/paths/~1entity/post/responses/502"
    post:
      operationId: createScreeningException
      summary: Create a new screening exception
      description: Creates a new screening exception.
      tags:
        - Screening Exceptions
      parameters:
        - name: Content-Type
          in: header
          description: The representation for the request.
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.conditional.exception+json
              - application/vnd.sas.watchlist.screening.conditional.exception+json;version=1
              - application/vnd.sas.watchlist.screening.profile.exception+json
              - application/vnd.sas.watchlist.screening.profile.exception+json;version=1
              - application/json
            default: application/vnd.sas.watchlist.screening.conditional.exception+json
        - name: Accept
          in: header
          description: The desired representation for the response.
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.conditional.exception+json
              - application/vnd.sas.watchlist.screening.conditional.exception+json;version=1
              - application/vnd.sas.watchlist.screening.profile.exception+json
              - application/vnd.sas.watchlist.screening.profile.exception+json;version=1
              - application/json
            default: application/vnd.sas.watchlist.screening.conditional.exception+json
      requestBody:
        description: The screening exception to create.
        required: true
        content:
          application/vnd.sas.watchlist.screening.conditional.exception+json:
            schema:
              $ref: "#/components/schemas/conditionalException"
            examples:
              Valid Conditional Exception Payload:
                $ref: "#/paths/~1exceptions/post/requestBody/content/application~1json/examples/Valid%20Conditional%20Exception%20Payload"
          application/vnd.sas.watchlist.screening.profile.exception+json:
            schema:
              $ref: "#/components/schemas/profileException"
            examples:
              Valid Profile Exception Payload:
                summary: Profile Exception
                description: Example of a profile exception.
                value:
                  identifier: T2
                  profileId: OFAC000000008124
          application/json:
            schema:
              $ref: "#/components/schemas/conditionalException"
            examples:
              Valid Conditional Exception Payload:
                summary: Conditional Exception
                description: Example of a conditional exception request structure.
                value:
                  expirationType: NEVER
                  conditions:
                    - path: /matchedProfile/tags
                      operator: contains
                      value: VSL
      responses:
        "201":
          description: The new screening exception was created.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
            Location:
              $ref: "#/paths/~1presets/post/responses/201/headers/Location"
          content:
            application/vnd.sas.watchlist.screening.conditional.exception+json:
              schema:
                $ref: "#/components/schemas/conditionalException"
              examples:
                Conditional Exception Created Response:
                  $ref: "#/paths/~1exceptions/post/responses/201/content/application~1json/examples/Conditional%20Exception%20Created%20Response"
            application/vnd.sas.watchlist.screening.profile.exception+json:
              schema:
                $ref: "#/components/schemas/profileException"
              examples:
                Profile Exception Created Response:
                  $ref: "#/paths/~1exceptions~1%7BscreeningExceptionId%7D/get/responses/200/content/application~1json/examples/Profile%20Exception"
            application/json:
              schema:
                $ref: "#/components/schemas/conditionalException"
              examples:
                Conditional Exception Created Response:
                  summary: Conditional Exception
                  description: A conditional exception response structure.
                  value:
                    id: cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
                    expirationType: NEVER
                    conditions:
                      - path: /matchedProfile/tags
                        operator: contains
                        value: VSL
                    status: ACTIVE
                    creationTimeStamp: 2024-01-11T20:46:21.883Z
                    modifiedTimeStamp: 2024-01-11T20:46:21.883Z
                    version: 1
                    links:
                      - method: GET
                        rel: up
                        href: /watchlistScreening/exceptions
                        uri: /watchlistScreening/exceptions
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.conditional.exception
                      - method: GET
                        rel: self
                        href: /watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
                        uri: /watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
                        type: application/vnd.sas.watchlist.screening.conditional.exception
                      - method: PUT
                        rel: update
                        href: /watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
                        uri: /watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
                        type: application/vnd.sas.watchlist.screening.conditional.exception
                        responseType: application/vnd.sas.watchlist.screening.conditional.exception
                      - method: DELETE
                        rel: delete
                        href: /watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
                        uri: /watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8
        "400":
          $ref: "#/paths/~1entity/post/responses/400"
        "404":
          $ref: "#/paths/~1/get/responses/404"
        "406":
          $ref: "#/paths/~1entity/post/responses/406"
        "415":
          $ref: "#/paths/~1entity/post/responses/415"
        "422":
          description: UnprocessableEntity.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Unprocessable Entity:
                  summary: Error - Unprocessable Entity
                  description: >
                    Content-type and syntax is correct, but the request could not be processed.
                  value:
                    version: 2
                    httpStatusCode: 422
                    message: Unprocessable Entity
                    details: Resource conflict
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
        "502":
          $ref: "#/paths/~1entity/post/responses/502"
  "/exceptions/{screeningExceptionId}":
    get:
      operationId: getScreeningException
      summary: Get a screening exception by its ID
      description: Returns a screening exception by its ID.
      tags:
        - Screening Exceptions
      parameters:
        - $ref: "#/paths/~1exceptions/post/parameters/1"
        - name: screeningExceptionId
          required: true
          description: The ID of the screening exception.
          in: path
          schema:
            type: string
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.watchlist.screening.conditional.exception+json:
              schema:
                $ref: "#/components/schemas/conditionalException"
              examples:
                Conditional Exception:
                  $ref: "#/paths/~1exceptions/post/responses/201/content/application~1json/examples/Conditional%20Exception%20Created%20Response"
            application/vnd.sas.watchlist.screening.profile.exception+json:
              schema:
                $ref: "#/components/schemas/profileException"
              examples:
                Profile Exception:
                  $ref: "#/paths/~1exceptions~1%7BscreeningExceptionId%7D/get/responses/200/content/application~1json/examples/Profile%20Exception"
            application/json:
              schema:
                oneOf:
                  - $ref: "#/components/schemas/profileException"
                  - $ref: "#/components/schemas/conditionalException"
              examples:
                Profile Exception:
                  summary: Profile Exception
                  description: A profile exception response structure.
                  value:
                    id: a6490a0c-7a1d-4b0e-9321-0bae3308c889
                    identifier: T2
                    profileId: OFAC000000008124
                    status: ACTIVE
                    creationTimeStamp: 2023-09-29T16:15:15.631Z
                    modifiedTimeStamp: 2023-09-29T16:15:15.631Z
                    version: 1
                    links:
                      - method: GET
                        rel: up
                        href: /watchlistScreening/exceptions
                        uri: /watchlistScreening/exceptions
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.conditional.exception
                      - method: GET
                        rel: self
                        href: /watchlistScreening/exceptions/a6490a0c-7a1d-4b0e-9321-0bae3308c889
                        uri: /watchlistScreening/exceptions/a6490a0c-7a1d-4b0e-9321-0bae3308c889
                        type: application/vnd.sas.watchlist.screening.profile.exception
                      - method: DELETE
                        rel: delete
                        href: /watchlistScreening/exceptions/a6490a0c-7a1d-4b0e-9321-0bae3308c889
                        uri: /watchlistScreening/exceptions/a6490a0c-7a1d-4b0e-9321-0bae3308c889
                Conditional Exception:
                  $ref: "#/paths/~1exceptions/post/responses/201/content/application~1json/examples/Conditional%20Exception%20Created%20Response"
        "400":
          $ref: "#/paths/~1entity/post/responses/400"
        "404":
          $ref: "#/paths/~1presets~1%7BpresetId%7D/get/responses/404"
        "406":
          $ref: "#/paths/~1entity/post/responses/406"
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
        "502":
          $ref: "#/paths/~1entity/post/responses/502"
    put:
      operationId: updateScreeningException
      summary: Update a screening exception by its ID
      description: Updates the specified screening exception. Only conditional exceptions can be updated, since profile exceptions do not contain any fields that are mutable after they are created.
      tags:
        - Screening Exceptions
      parameters:
        - $ref: "#/paths/~1exceptions~1%7BscreeningExceptionId%7D/get/parameters/1"
        - name: Content-Type
          in: header
          description: The representation for the request.
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.conditional.exception+json
              - application/vnd.sas.watchlist.screening.conditional.exception+json;version=1
              - application/json
            default: application/vnd.sas.watchlist.screening.conditional.exception+json
        - name: Accept
          in: header
          description: The desired representation for the response.
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.conditional.exception+json
              - application/vnd.sas.watchlist.screening.conditional.exception+json;version=1
              - application/json
            default: application/vnd.sas.watchlist.screening.conditional.exception+json
      requestBody:
        description: The screening exception to update.
        required: true
        content:
          application/vnd.sas.watchlist.screening.conditional.exception+json:
            schema:
              $ref: "#/components/schemas/conditionalException"
            examples:
              Valid Conditional Exception Payload:
                $ref: "#/paths/~1exceptions/post/requestBody/content/application~1json/examples/Valid%20Conditional%20Exception%20Payload"
          application/json:
            schema:
              $ref: "#/components/schemas/conditionalException"
            examples:
              Valid Conditional Exception Payload:
                $ref: "#/paths/~1exceptions/post/requestBody/content/application~1json/examples/Valid%20Conditional%20Exception%20Payload"
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.watchlist.screening.conditional.exception+json:
              schema:
                $ref: "#/components/schemas/conditionalException"
              examples:
                Conditional Exception Created Response:
                  $ref: "#/paths/~1exceptions/post/responses/201/content/application~1json/examples/Conditional%20Exception%20Created%20Response"
            application/json:
              schema:
                $ref: "#/components/schemas/conditionalException"
              examples:
                Conditional Exception Created Response:
                  $ref: "#/paths/~1exceptions/post/responses/201/content/application~1json/examples/Conditional%20Exception%20Created%20Response"
        "400":
          $ref: "#/paths/~1entity/post/responses/400"
        "404":
          $ref: "#/paths/~1presets~1%7BpresetId%7D/get/responses/404"
        "406":
          $ref: "#/paths/~1entity/post/responses/406"
        "415":
          $ref: "#/paths/~1entity/post/responses/415"
        "422":
          $ref: "#/paths/~1exceptions/post/responses/422"
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
        "502":
          $ref: "#/paths/~1entity/post/responses/502"
    delete:
      operationId: deleteScreeningException
      summary: Delete a screening exception by its ID
      description: Deletes the specified screening exception.
      tags:
        - Screening Exceptions
      parameters:
        - $ref: "#/paths/~1exceptions~1%7BscreeningExceptionId%7D/get/parameters/1"
      responses:
        "204":
          description: The request succeeded.
        "400":
          $ref: "#/paths/~1entity/post/responses/400"
        "401":
          $ref: "#/paths/~1presets~1%7BpresetId%7D/delete/responses/401"
        "403":
          $ref: "#/paths/~1presets~1%7BpresetId%7D/delete/responses/403"
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
        "502":
          $ref: "#/paths/~1entity/post/responses/502"
  "/profiles/{profileId}":
    get:
      operationId: getWatchlistProfile
      summary: Get a watchlist profile by its profile ID and checksum
      description: Returns the requested watchlist profile data.
      tags:
        - Watchlist Profiles
      parameters:
        - name: profileId
          required: true
          description: The ID of the watchlist profile.
          in: path
          schema:
            type: string
            minLength: 16
            maxLength: 16
        - name: checksum
          description: >-
            The checksum that is associated with a specific version of the publicized watchlist profile data. This is an optional value. If omitted, the request attempts to return the version of the profile data that was processed most recently.

            If the value `@latest` is specified, the request attempts to fetch the latest version of the profile data from the watchlist provider. The use of this option does not involve the submission of a screening request.
          in: query
          schema:
            oneOf:
              - type: integer
                minimum: -2147483648
                maximum: 2147483647
              - type: string
                enum:
                  - "@latest"
                default: "@latest"
                description: Use `@latest` to retrieve the latest profile.
        - $ref: "#/paths/~1entity~1%7BpartyId%7D/get/parameters/1"
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/json:
              examples:
                Watchlist Profile:
                  summary: Watchlist Profile
                  description: A watchlist profile response structure.
                  value:
                    _id: OFAC000000035767
                    _schema: 1.1.0
                    analytics:
                      countryHeatMap:
                        - code: ru
                          count: 1
                      mediaAgeScore: 0
                      mediaQuantityScore: 0
                      sanctionPaths: []
                      sanctionProximityScore: 100
                    classification:
                      categories:
                        - RUSSIA-EO14024
                      tags:
                        - SAN
                      type: I
                    compressedAnalytics: 100|0|0|1/ru:1
                    identity:
                      addresses:
                        - address: B. Dorogomilovskaia - 7 81 -
                          city: Moscow
                          country: ru
                          zip: "127473"
                      aliases:
                        - affinity: ru
                          firstName: Nikolai
                          name: CHOLES
                          quality: STD
                          type: AKA
                        - affinity: ru
                          firstName: Nikolay Dmitrievich
                          name: CHOULZ
                          quality: STD
                          type: AKA
                        - affinity: ru
                          firstName: Nikolay Dmitriyevich
                          name: CHOULZ
                          quality: STD
                          type: AKA
                      birth:
                        dates:
                          - day: 3
                            month: 2
                            year: 1990
                        places:
                          - country: ru
                            state: Moscow
                      countries:
                        nationality:
                          - ru
                      documents:
                        nationalId:
                          - issuer: ru
                            value: "4516913332"
                        passport:
                          - fromDate:
                              day: 12
                              month: 9
                              year: 2012
                            issuer: ru
                            toDate:
                              day: 12
                              month: 9
                              year: 2022
                            value: "721123760"
                      gender: M
                      name:
                        affinity: ru
                        firstName: Nikolay
                        name: PESKOV
                        quality: STD
                        type: PRI
                    notes: >-
                      (Linked To: PESKOV, Dmitriy Sergeevich)

                      Passport: 721123760 (Country: Russia, Issue: 12 Sep 2012, Expiration: 12 Sep 2022)

                      National ID No.: 4516913332 (Country: Russia)

                      Gender: Male
                    links:
                      - href: /watchlistScreening/profile/OFAC000000035767?checksum=1701216758
                        method: GET
                        rel: self
                        type: application/json
                        uri: /watchlistScreening/profile/OFAC000000035767?checksum=1701216758
                    publication:
                      action: ""
                      checksum: 1701216758
                      coreChecksum: -1522343026
                      listId: OFAC
                      listName: OFAC
                      listVersion:
                        day: 17
                        month: 11
                        year: 2023
                      localId: "35767"
                      updated:
                        day: 17
                        month: 11
                        year: 2023
                    processingTimeStamp: 2023-12-05T17:28:08.820958Z
                    sanctions:
                      - issuerCode: OFACSD
                        issuerCountry: us
                        list: OFAC - Specially Designated Nationals
        "400":
          description: Bad request (the request is not well-formed).
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Bad Request:
                  summary: Error - Bad Request
                  description: >
                    The request could not be processed. When available, the error response contains additional details.
                  value:
                    version: 2
                    httpStatusCode: 400
                    message: Bad Request
                    details: 'Could not process the request with the parameters: profileId = "OFAC000000018428", checksum = -4871588784'
        "404":
          description: The specified resource was not found.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Not Found:
                  summary: Error - Not Found
                  description: The specified resource was not found.
                  value:
                    version: 2
                    httpStatusCode: 404
                    message: Not Found
                    details: 'No watchlist profile was found that is associated with the parameters: profileID = "CITY000000001234", checksum = -123456789'
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
  /collection/categories:
    get:
      operationId: getWatchlistCategories
      summary: Get a list of watchlist category metadata organized by date
      description: >
        Returns a list of watchlist category metadata, where each

        element of the list identifies the categories for the watchlist

        on that date.
      tags:
        - Watchlist Metadata
      parameters:
        - $ref: "#/paths/~1presets/get/parameters/0"
        - name: Accept-Item
          description: The desired item representation for collections; the default is application/vnd.sas.watchlist.screening.collection.categories+json.
          in: header
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.collection.categories+json
              - application/json
            default: application/vnd.sas.watchlist.screening.collection.categories+json
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.collection+json:
              schema:
                $ref: "#/components/schemas/watchlistCategoriesCollection"
              examples:
                Watchlist Categories Collection:
                  $ref: "#/paths/~1collection~1categories/get/responses/200/content/application~1json/examples/Watchlist%20Categories"
            application/json:
              schema:
                $ref: "#/components/schemas/watchlistCategoriesCollection"
              examples:
                Watchlist Categories:
                  summary: Watchlist sanction categories
                  description: The response structure for watchlist sanction categories.
                  value:
                    version: 2
                    accept: application/vnd.sas.watchlist.screening.collection.categories
                    count: 3
                    start: 0
                    limit: 3
                    name: watchlist sanction categories
                    items:
                      - watchlist: un
                        captureDt: 2023-12-15
                        data:
                          - listId: UN
                            category: Al-Qaida
                          - listId: UN
                            category: CAR
                          - listId: UN
                            category: DPRK
                          - listId: UN
                            category: DRC
                          - listId: UN
                            category: GB
                          - listId: UN
                            category: Haiti
                          - listId: UN
                            category: Iraq
                          - listId: UN
                            category: Libya
                          - listId: UN
                            category: Somalia
                          - listId: UN
                            category: SouthSudan
                          - listId: UN
                            category: Sudan
                          - listId: UN
                            category: Taliban
                          - listId: UN
                            category: Yemen
                        links:
                          - href: /watchlistScreening/collection/categories
                            method: GET
                            rel: up
                            type: application/vnd.sas.collection
                            itemType: application/vnd.sas.watchlist.screening.collection.categories
                            uri: /watchlistScreening/collection/categories
                          - href: /watchlistScreening/collection/categories/2023-12-15
                            method: GET
                            rel: self
                            type: application/vnd.sas.watchlist.screening.collection.categories
                            uri: /watchlistScreening/collection/categories/2023-12-15
                      - watchlist: un
                        captureDt: 2023-12-14
                        data:
                          - listId: UN
                            category: Al-Qaida
                          - listId: UN
                            category: CAR
                          - listId: UN
                            category: DPRK
                          - listId: UN
                            category: DRC
                          - listId: UN
                            category: GB
                          - listId: UN
                            category: Haiti
                          - listId: UN
                            category: Iraq
                          - listId: UN
                            category: Libya
                          - listId: UN
                            category: Somalia
                          - listId: UN
                            category: SouthSudan
                          - listId: UN
                            category: Sudan
                          - listId: UN
                            category: Taliban
                          - listId: UN
                            category: Yemen
                        links:
                          - href: /watchlistScreening/collection/categories
                            method: GET
                            rel: up
                            type: application/vnd.sas.collection
                            itemType: application/vnd.sas.watchlist.screening.collection.categories
                            uri: /watchlistScreening/collection/categories
                          - href: /watchlistScreening/collection/categories/2023-12-14
                            method: GET
                            rel: self
                            type: application/vnd.sas.watchlist.screening.collection.categories
                            uri: /watchlistScreening/collection/categories/2023-12-14
                      - watchlist: un
                        captureDt: 2023-12-13
                        data:
                          - listId: UN
                            category: Al-Qaida
                          - listId: UN
                            category: CAR
                          - listId: UN
                            category: DPRK
                          - listId: UN
                            category: DRC
                          - listId: UN
                            category: GB
                          - listId: UN
                            category: Haiti
                          - listId: UN
                            category: Iraq
                          - listId: UN
                            category: Libya
                          - listId: UN
                            category: Somalia
                          - listId: UN
                            category: SouthSudan
                          - listId: UN
                            category: Sudan
                          - listId: UN
                            category: Taliban
                          - listId: UN
                            category: Yemen
                        links:
                          - href: /watchlistScreening/collection/categories
                            method: GET
                            rel: up
                            type: application/vnd.sas.collection
                            itemType: application/vnd.sas.watchlist.screening.collection.categories
                            uri: /watchlistScreening/collection/categories
                          - href: /watchlistScreening/collection/categories/2023-12-13
                            method: GET
                            rel: self
                            type: application/vnd.sas.watchlist.screening.collection.categories
                            uri: /watchlistScreening/collection/categories/2023-12-13
                    links:
                      - method: GET
                        rel: self
                        href: /watchlistScreening/collection/categories
                        uri: /watchlistScreening/collection/categories
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.collection.categories
        "404":
          description: The specified resource was not found.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Not Found:
                  summary: Error - Not Found
                  description: The specified resource was not found.
                  value:
                    version: 2
                    httpStatusCode: 404
                    message: Not Found
                    details: No watchlist categories were found.
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
  /collection/sanctionCodes:
    get:
      operationId: getWatchlistSanctionCodes
      summary: Get a list of watchlist sanction code metadata organized by date
      description: >
        Returns a list of watchlist sanction code metadata, where each

        element of the list identifies the sanction codes for the watchlist

        on that date.
      tags:
        - Watchlist Metadata
      parameters:
        - $ref: "#/paths/~1presets/get/parameters/0"
        - name: Accept-Item
          description: The desired item representation for collections; the default is application/vnd.sas.watchlist.screening.collection.sanction.codes+json.
          in: header
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.collection.sanction.codes+json
              - application/json
            default: application/vnd.sas.watchlist.screening.collection.sanction.codes+json
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.collection+json:
              schema:
                $ref: "#/components/schemas/watchlistSanctionCodesCollection"
              examples:
                Watchlist Sanction Codes Collection:
                  $ref: "#/paths/~1collection~1sanctionCodes/get/responses/200/content/application~1json/examples/Watchlist%20Sanction%20Codes"
            application/json:
              schema:
                $ref: "#/components/schemas/watchlistSanctionCodesCollection"
              examples:
                Watchlist Sanction Codes:
                  summary: Watchlist sanction codes
                  description: The response structure for watchlist sanction codes.
                  value:
                    version: 2
                    accept: application/vnd.sas.watchlist.screening.collection.sanction.codes
                    count: 2
                    start: 0
                    limit: 2
                    name: watchlist sanction codes
                    items:
                      - watchlist: ofac
                        captureDt: 2023-12-15
                        data:
                          - code: OFACSD
                            labels:
                              - OFAC - Specially Designated Nationals
                            listId: OFAC
                            country: us
                        links:
                          - href: /watchlistScreening/collection/sanctionCodes
                            method: GET
                            rel: up
                            type: application/vnd.sas.collection
                            itemType: application/vnd.sas.watchlist.screening.collection.sanction.codes
                            uri: /watchlistScreening/collection/sanctionCodes
                          - href: /watchlistScreening/collection/sanctionCodes/2023-12-15
                            method: GET
                            rel: self
                            type: application/vnd.sas.watchlist.screening.collection.sanction.codes
                            uri: /watchlistScreening/collection/sanctionCodes/2023-12-15
                      - watchlist: ofac
                        captureDt: 2023-12-14
                        data:
                          - code: OFACSD
                            labels:
                              - OFAC - Specially Designated Nationals
                            listId: OFAC
                            country: us
                        links:
                          - href: /watchlistScreening/collection/sanctionCodes
                            method: GET
                            rel: up
                            type: application/vnd.sas.collection
                            itemType: application/vnd.sas.watchlist.screening.collection.sanction.codes
                            uri: /watchlistScreening/collection/sanctionCodes
                          - href: /watchlistScreening/collection/sanctionCodes/2023-12-14
                            method: GET
                            rel: self
                            type: application/vnd.sas.watchlist.screening.collection.sanction.codes
                            uri: /watchlistScreening/collection/sanctionCodes/2023-12-14
                    links:
                      - href: /watchlistScreening/collection/sanctionCodes
                        method: GET
                        rel: self
                        type: application/vnd.sas.collection
                        uri: /watchlistScreening/collection/sanctionCodes
                        itemType: application/vnd.sas.watchlist.screening.collection.sanction.codes
        "404":
          description: The specified resource was not found.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Not Found:
                  summary: Error - Not Found
                  description: The specified resource was not found.
                  value:
                    version: 2
                    httpStatusCode: 404
                    message: Not Found
                    details: No watchlist sanction codes were found.
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
  /collection/regions:
    get:
      operationId: getWatchlistRegions
      summary: Get a list of watchlist region metadata organized by date
      description: >
        Returns a list of watchlist region metadata, where each

        element of the list identifies the country and a list of

        regions associated with that country on that date.
      tags:
        - Watchlist Metadata
      parameters:
        - $ref: "#/paths/~1presets/get/parameters/0"
        - name: Accept-Item
          description: The desired item representation for collections; the default is application/vnd.sas.watchlist.screening.collection.region+json.
          in: header
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.collection.region+json
              - application/vnd.sas.watchlist.screening.collection.region+json;version=1
              - application/json
            default: application/vnd.sas.watchlist.screening.collection.region+json
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.collection+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/200/content/application~1json/schema"
              examples:
                Watchlist Region Collection:
                  $ref: "#/paths/~1collection~1regions/get/responses/200/content/application~1json/examples/Watchlist%20Region%20Collection"
            application/json:
              schema:
                title: Watchlist Region Collection
                description: A collection of watchlist region data.
                allOf:
                  - $ref: "#/components/schemas/presetCollection/allOf/0"
                  - type: object
                    required:
                      - items
                    properties:
                      items:
                        type: array
                        items:
                          $ref: "#/paths/~1collection~1regions~1%40latest/get/responses/200/content/application~1json/schema"
              examples:
                Watchlist Region Collection:
                  summary: Watchlist regions
                  description: The response structure for a collection of watchlist regions. The content has been edited for brevity.
                  value:
                    accept: application/vnd.sas.watchlist.screening.collection.region
                    name: watchlist regions
                    start: 0
                    count: 1
                    limit: 1
                    version: 2
                    items:
                      - captureDt: 2024-05-15
                        watchlist: EU
                        data:
                          - country: us
                            regions:
                              - west virginia
                              - kentucky
                              - arizona
                              - pennsylvania
                              - new hampshire
                              - louisiana
                              - california
                              - new jersey
                              - minnesota
                              - wyoming
                              - ohio
                              - iowa
                              - florida
                              - wisconsin
                              - district of columbia
                              - alabama
                              - north dakota
                              - vermont
                              - nebraska
                              - hawaii
                              - utah
                              - colorado
                              - north carolina
                              - south carolina
                              - virginia
                              - kansas
                              - rhode island
                              - new mexico
                              - arkansas
                              - tennessee
                              - new york
                              - delaware
                              - illinois
                              - indiana
                              - idaho
                              - maine
                              - nevada
                              - connecticut
                              - texas
                              - alaska
                              - michigan
                              - washington
                              - mississippi
                              - missouri
                              - georgia
                              - oklahoma
                              - montana
                              - maryland
                              - oregon
                              - south dakota
                              - massachusetts
                          - country: au
                            regions:
                              - state of south australia
                              - state of western australia
                              - state of new south wales
                              - australian capital territory
                              - state of queensland
                              - state of tasmania
                              - state of victoria
                              - northern territory
                        links:
                          - href: /watchlistScreening/collection/regions
                            itemType: application/vnd.sas.watchlist.screening.collection.region
                            method: GET
                            rel: up
                            type: application/vnd.sas.collection
                            uri: /watchlistScreening/collection/regions
                          - href: /watchlistScreening/collection/regions/2024-05-15
                            method: GET
                            rel: self
                            type: application/vnd.sas.watchlist.screening.collection.region
                            uri: /watchlistScreening/collection/regions/2024-05-15
                    links:
                      - href: /watchlistScreening/collection/regions
                        itemType: application/vnd.sas.watchlist.screening.collection.region
                        method: GET
                        rel: self
                        type: application/vnd.sas.collection
                        uri: /watchlistScreening/collection/regions
        "404":
          description: The specified resource was not found.
          content:
            application/vnd.sas.error+json:
              schema:
                title: Error
                type: object
                description: The representation of an error.
                x-sas-media-type:
                  name: application/vnd.sas.error
                  version: 2
                required:
                  - httpStatusCode
                  - version
                properties:
                  message:
                    type: string
                    description: The message for the error.
                  id:
                    type: string
                    description: The string ID for the error.
                  errorCode:
                    type: integer
                    description: The numeric ID for the error.
                  httpStatusCode:
                    type: integer
                    description: The HTTP status code for the error.
                  details:
                    type: array
                    description: Messages that provide additional details about the cause of the error.
                    items:
                      type: string
                  remediation:
                    type: string
                    description: A message that describes how to resolve the error.
                  errors:
                    type: array
                    description: Any additional errors that occurred.
                    items:
                      $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
                  links:
                    type: array
                    description: The links that apply to the error.
                    items:
                      $ref: "#/components/schemas/preset/properties/links/items"
                  version:
                    type: integer
                    description: The version number of the error representation. This representation is version 2.
              examples:
                Error - Not Found:
                  summary: Error - Not Found
                  description: The specified resource was not found.
                  value:
                    version: 2
                    httpStatusCode: 404
                    message: Not Found
                    details: No watchlist regions were found.
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
  "/collection/categories/{date}":
    get:
      operationId: getWatchlistCategoriesByDate
      summary: Get a list of watchlist categories for a given date
      description: Returns a watchlist and its corresponding categories for the given date.
      tags:
        - Watchlist Metadata
      parameters:
        - $ref: "#/paths/~1collection~1regions~1%7Bdate%7D/get/parameters/0"
        - $ref: "#/paths/~1collection~1categories~1%40latest/get/parameters/0"
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.watchlist.screening.collection.categories+json:
              schema:
                $ref: "#/components/schemas/watchlistCategories"
              examples:
                Watchlist Metadata:
                  $ref: "#/paths/~1collection~1categories~1%40latest/get/responses/200/content/application~1json/examples/Watchlist%20Metadata"
            application/json:
              schema:
                $ref: "#/components/schemas/watchlistCategories"
              examples:
                Watchlist Metadata:
                  $ref: "#/paths/~1collection~1categories~1%40latest/get/responses/200/content/application~1json/examples/Watchlist%20Metadata"
        "400":
          description: Bad request (the request is not well-formed).
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Bad Request:
                  summary: Error - Bad Request
                  description: >
                    The request could not be processed. When available, the error response contains additional details.
                  value:
                    version: 2
                    httpStatusCode: 400
                    message: Bad Request
                    details: 'Could not process the request with the parameters: date = "dec-01-23"'
        "404":
          description: The specified resource was not found.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Not Found:
                  summary: Error - Not Found
                  description: The specified resource was not found.
                  value:
                    version: 2
                    httpStatusCode: 404
                    message: Not Found
                    details: 'No watchlist categories were found for the given date: "2023-12-01"'
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
  "/collection/sanctionCodes/{date}":
    get:
      operationId: getWatchlistSanctionCodesByDate
      summary: Get a list of watchlist sanction codes for a given date
      description: Returns a watchlist and its corresponding sanction codes for the given date.
      tags:
        - Watchlist Metadata
      parameters:
        - $ref: "#/paths/~1collection~1regions~1%7Bdate%7D/get/parameters/0"
        - $ref: "#/paths/~1collection~1sanctionCodes~1%40latest/get/parameters/0"
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.watchlist.screening.collection.sanction.codes+json:
              schema:
                $ref: "#/components/schemas/watchlistSanctionCodes"
              examples:
                Watchlist Metadata:
                  $ref: "#/paths/~1collection~1sanctionCodes~1%40latest/get/responses/200/content/application~1json/examples/Watchlist%20Metadata"
            application/json:
              schema:
                $ref: "#/components/schemas/watchlistSanctionCodes"
              examples:
                Watchlist Metadata:
                  $ref: "#/paths/~1collection~1sanctionCodes~1%40latest/get/responses/200/content/application~1json/examples/Watchlist%20Metadata"
        "400":
          description: Bad request (the request is not well-formed).
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Bad Request:
                  summary: Error - Bad Request
                  description: >
                    The request could not be processed. When available, the error response contains additional details.
                  value:
                    version: 2
                    httpStatusCode: 400
                    message: Bad Request
                    details: 'Could not process the request with the parameters: date = "dec-01-23"'
        "404":
          description: The specified resource was not found.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Not Found:
                  summary: Error - Not Found
                  description: The specified resource was not found.
                  value:
                    version: 2
                    httpStatusCode: 404
                    message: Not Found
                    details: 'No watchlist sanction codes were found for the given date: "2023-12-01"'
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
  "/collection/regions/{date}":
    get:
      operationId: getWatchlistRegionsByDate
      summary: Get a list of watchlist region metadata for a given date
      description: Returns region metadata for the given date.
      tags:
        - Watchlist Metadata
      parameters:
        - name: date
          required: true
          description: The processing date of the watchlist metadata. The processing date uses 'YYYY-MM-DD' format.
          in: path
          schema:
            type: string
            format: date
        - $ref: "#/paths/~1collection~1regions~1%40latest/get/parameters/0"
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.watchlist.screening.collection.region+json:
              schema:
                $ref: "#/paths/~1collection~1regions~1%40latest/get/responses/200/content/application~1json/schema"
              examples:
                Watchlist Metadata:
                  $ref: "#/paths/~1collection~1regions~1%40latest/get/responses/200/content/application~1json/examples/Watchlist%20Metadata"
            application/json:
              schema:
                $ref: "#/paths/~1collection~1regions~1%40latest/get/responses/200/content/application~1json/schema"
              examples:
                Watchlist Metadata:
                  $ref: "#/paths/~1collection~1regions~1%40latest/get/responses/200/content/application~1json/examples/Watchlist%20Metadata"
        "400":
          description: Bad request (the request is not well-formed).
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Bad Request:
                  summary: Error - Bad Request
                  description: >
                    The request could not be processed. When available, the error response contains additional details.
                  value:
                    version: 2
                    httpStatusCode: 400
                    message: Bad Request
                    details: 'Could not process the request with the parameters: date = "dec-01-23"'
        "404":
          description: The specified resource was not found.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Not Found:
                  summary: Error - Not Found
                  description: The specified resource was not found.
                  value:
                    version: 2
                    httpStatusCode: 404
                    message: Not Found
                    details: 'No watchlist region data was found for the given date: "2023-12-01"'
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
  /collection/categories/@latest:
    get:
      operationId: getWatchlistCategoriesLatest
      summary: Get a list of the latest watchlist categories
      description: Returns a watchlist and the latest version of its corresponding categories. The latest version is based on the capture date timestamp.
      tags:
        - Watchlist Metadata
      parameters:
        - name: Accept
          in: header
          description: The desired representation for the response.
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.collection.categories+json
              - application/vnd.sas.watchlist.screening.collection.categories+json;version=1
              - application/json
            default: application/vnd.sas.watchlist.screening.collection.categories+json
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.watchlist.screening.collection.categories+json:
              schema:
                $ref: "#/components/schemas/watchlistCategories"
              examples:
                Watchlist Metadata:
                  $ref: "#/paths/~1collection~1categories~1%40latest/get/responses/200/content/application~1json/examples/Watchlist%20Metadata"
            application/json:
              schema:
                $ref: "#/components/schemas/watchlistCategories"
              examples:
                Watchlist Metadata:
                  summary: Watchlist sanction categories on a given date
                  description: The response structure for watchlist sanction categories on a given date.
                  value:
                    watchlist: un
                    captureDt: 2023-12-14
                    data:
                      - listId: UN
                        category: Al-Qaida
                      - listId: UN
                        category: CAR
                      - listId: UN
                        category: DPRK
                      - listId: UN
                        category: DRC
                      - listId: UN
                        category: GB
                      - listId: UN
                        category: Haiti
                      - listId: UN
                        category: Iraq
                      - listId: UN
                        category: Libya
                      - listId: UN
                        category: Somalia
                      - listId: UN
                        category: SouthSudan
                      - listId: UN
                        category: Sudan
                      - listId: UN
                        category: Taliban
                      - listId: UN
                        category: Yemen
                    links:
                      - href: /watchlistScreening/collection/categories
                        method: GET
                        rel: up
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.collection.categories
                        uri: /watchlistScreening/collection/categories
                      - href: /watchlistScreening/collection/categories/2023-12-14
                        method: GET
                        rel: self
                        type: application/vnd.sas.watchlist.screening.collection.categories
                        uri: /watchlistScreening/collection/categories/2023-12-14
        "404":
          description: The specified resource was not found.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Not Found:
                  summary: Error - Not Found
                  description: The specified resource was not found.
                  value:
                    version: 2
                    httpStatusCode: 404
                    message: Not Found
                    details: 'No watchlist categories were found for the given date: "@latest"'
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
  /collection/sanctionCodes/@latest:
    get:
      operationId: getWatchlistSanctionCodesLatest
      summary: Get a list of the latest watchlist sanction codes
      description: Returns a watchlist and the latest version of its corresponding sanction codes. The latest version is based on the capture date timestamp.
      tags:
        - Watchlist Metadata
      parameters:
        - name: Accept
          in: header
          description: The desired representation for the response.
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.collection.sanction.codes+json
              - application/vnd.sas.watchlist.screening.collection.sanction.codes+json;version=1
              - application/json
            default: application/vnd.sas.watchlist.screening.collection.sanction.codes+json
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.watchlist.screening.collection.sanction.codes+json:
              schema:
                $ref: "#/components/schemas/watchlistSanctionCodes"
              examples:
                Watchlist Metadata:
                  $ref: "#/paths/~1collection~1sanctionCodes~1%40latest/get/responses/200/content/application~1json/examples/Watchlist%20Metadata"
            application/json:
              schema:
                $ref: "#/components/schemas/watchlistSanctionCodes"
              examples:
                Watchlist Metadata:
                  summary: Watchlist sanction codes on a given date
                  description: The response structure for watchlist sanction codes on a given date.
                  value:
                    watchlist: ofac
                    captureDt: 2023-12-14
                    data:
                      - code: OFACSD
                        labels:
                          - OFAC - Specially Designated Nationals
                        listId: OFAC
                        country: us
                    links:
                      - href: /watchlistScreening/collection/sanctionCodes
                        method: GET
                        rel: up
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.collection.sanction.codes
                        uri: /watchlistScreening/collection/sanctionCodes
                      - href: /watchlistScreening/collection/sanctionCodes/2023-12-14
                        method: GET
                        rel: self
                        type: application/vnd.sas.watchlist.screening.collection.sanction.codes
                        uri: /watchlistScreening/collection/sanctionCodes/2023-12-14
        "404":
          description: The specified resource was not found.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Not Found:
                  summary: Error - Not Found
                  description: The specified resource was not found.
                  value:
                    version: 2
                    httpStatusCode: 404
                    message: Not Found
                    details: 'No watchlist sanction codes were found for the given date: "@latest"'
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
  /collection/regions/@latest:
    get:
      operationId: getWatchlistRegionsLatest
      summary: Get a list of the latest watchlist region metadata
      description: Returns a watchlist and the latest version of its corresponding region metadata. The latest version is based on the capture date timestamp.
      tags:
        - Watchlist Metadata
      parameters:
        - name: Accept
          in: header
          description: The desired representation for the response.
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.collection.region+json
              - application/vnd.sas.watchlist.screening.collection.region+json;version=1
              - application/json
            default: application/vnd.sas.watchlist.screening.collection.region+json
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.watchlist.screening.collection.region+json:
              schema:
                $ref: "#/paths/~1collection~1regions~1%40latest/get/responses/200/content/application~1json/schema"
              examples:
                Watchlist Metadata:
                  $ref: "#/paths/~1collection~1regions~1%40latest/get/responses/200/content/application~1json/examples/Watchlist%20Metadata"
            application/json:
              schema:
                title: Watchlist Region
                description: Metadata that contains information about a region that is available to use during screening operations.
                type: object
                properties:
                  captureDt:
                    type: string
                    description: The date on which the watchlist was captured.
                  data:
                    type: array
                    description: The list of region objects, organized by country.
                    items:
                      type: object
                      properties:
                        country:
                          type: string
                          description: The country associated with the region.
                        regions:
                          type: array
                          description: A list of regions associated with the country.
                          items:
                            type: string
                  links:
                    type: array
                    description: The links that apply to the object. The value is ignored on input.
                    items:
                      $ref: "#/components/schemas/preset/properties/links/items"
                    readOnly: true
              examples:
                Watchlist Metadata:
                  summary: Watchlist region
                  description: The response structure for watchlist region data on a given date. The content has been edited for brevity.
                  value:
                    captureDt: 2024-05-15
                    watchlist: EU
                    data:
                      - country: us
                        regions:
                          - west virginia
                          - kentucky
                          - arizona
                          - pennsylvania
                          - new hampshire
                          - louisiana
                          - california
                          - new jersey
                          - minnesota
                          - wyoming
                          - ohio
                          - iowa
                          - florida
                          - wisconsin
                          - district of columbia
                          - alabama
                          - north dakota
                          - vermont
                          - nebraska
                          - hawaii
                          - utah
                          - colorado
                          - north carolina
                          - south carolina
                          - virginia
                          - kansas
                          - rhode island
                          - new mexico
                          - arkansas
                          - tennessee
                          - new york
                          - delaware
                          - illinois
                          - indiana
                          - idaho
                          - maine
                          - nevada
                          - connecticut
                          - texas
                          - alaska
                          - michigan
                          - washington
                          - mississippi
                          - missouri
                          - georgia
                          - oklahoma
                          - montana
                          - maryland
                          - oregon
                          - south dakota
                          - massachusetts
                      - country: au
                        regions:
                          - state of south australia
                          - state of western australia
                          - state of new south wales
                          - australian capital territory
                          - state of queensland
                          - state of tasmania
                          - state of victoria
                          - northern territory
                    links:
                      - href: /watchlistScreening/collection/regions
                        itemType: application/vnd.sas.watchlist.screening.collection.region
                        method: GET
                        rel: up
                        type: application/vnd.sas.collection
                        uri: /watchlistScreening/collection/regions
                      - href: /watchlistScreening/collection/regions/2024-05-15
                        method: GET
                        rel: self
                        type: application/vnd.sas.watchlist.screening.collection.region
                        uri: /watchlistScreening/collection/regions/2024-05-15
        "404":
          description: The specified resource was not found.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/paths/~1collection~1regions/get/responses/404/content/application~1vnd.sas.error%2Bjson/schema"
              examples:
                Error - Not Found:
                  summary: Error - Not Found
                  description: The specified resource was not found.
                  value:
                    version: 2
                    httpStatusCode: 404
                    message: Not Found
                    details: 'No watchlist region data was found for the given date: "@latest"'
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
  /statistics:
    get:
      operationId: getWatchlistScreeningStats
      summary: Get the watchlist screening statistics
      description: Returns the requested watchlist screening statistics.
      tags:
        - Watchlist Screening Statistics
      parameters:
        - name: to
          description: The end date, in YYYY-MM-DD format expressed in UTC (Universal Time Coordinated), of the time frame to use for the data extraction.
          in: query
          schema:
            type: string
            format: date
        - name: from
          required: true
          description: The start date, in YYYY-MM-DD format expressed in UTC (Universal Time Coordinated), of the time frame to use for the data extraction.
          in: query
          schema:
            type: string
            format: date
        - name: Accept
          in: header
          description: The desired representation for the response.
          schema:
            type: string
            enum:
              - application/vnd.sas.watchlist.screening.statistics+json
              - application/json
            default: application/vnd.sas.watchlist.screening.statistics+json
      responses:
        "200":
          description: The request succeeded.
          headers:
            Content-Type:
              $ref: "#/paths/~1/get/responses/200/headers/Content-Type"
          content:
            application/vnd.sas.collection+json:
              schema:
                $ref: "#/components/schemas/watchlistScreeningStatsCollection"
              examples:
                Watchlist Screening Stats Collection:
                  $ref: "#/paths/~1statistics/get/responses/200/content/application~1json/examples/Watchlist%20Screening%20Stats"
            application/json:
              schema:
                $ref: "#/components/schemas/watchlistScreeningStatsCollection"
              examples:
                Watchlist Screening Stats:
                  summary: Watchlist Screening Statistics Collection
                  description: A collection of watchlist screening statistics.
                  value:
                    version: 2
                    name: watchlist screening statistics
                    accept: application/vnd.sas.watchlist.screening.statistics
                    count: 2
                    start: 0
                    limit: 2
                    items:
                      - collection: sanctions
                        date: 2024-02-14T00:00:00Z
                        counters:
                          entityScreeningRequests: 3
                          paymentScreeningRequests: 0
                      - collection: sanctions
                        date: 2024-02-12T00:00:00Z
                        counters:
                          entityScreeningRequests: 1
                          paymentScreeningRequests: 0
                    links:
                      - method: GET
                        rel: up
                        href: /watchlistScreening
                        uri: /watchlistScreening
                        type: application/vnd.sas.api
                      - method: GET
                        rel: self
                        href: /watchlistScreening/statistics?from=2024-02-12&to=2024-02-14
                        uri: /watchlistScreening/statistics?from=2024-02-12&to=2024-02-14
                        type: application/vnd.sas.collection
                        itemType: application/vnd.sas.watchlist.screening.statistics+json
        "400":
          $ref: "#/paths/~1entity/post/responses/400"
        "404":
          $ref: "#/paths/~1/get/responses/404"
        "500":
          $ref: "#/paths/~1presets/get/responses/500"
components:
  schemas:
    entityScreening:
      title: Entity Screening
      description: The collection of objects that are required to screen an entity. This is the default configuration. This request is based on a message schema and might change after deployment.
      type: object
      properties:
        message:
          type: object
          required:
            - party
          properties:
            screeningOptions:
              title: Screening Options
              type: object
              description: The options that are applied during an entity screening request.
              properties:
                messageReference:
                  title: Message Reference
                  type: string
                  description: The unique identifier that is generated by SAS Real-Time Watchlist Screening for a screening request. This value is populated in the screening response and is ignored on input.
                  minLength: 0
                  maxLength: 36
                  readOnly: true
                projectReference:
                  title: Project Reference
                  type: string
                  description: A project reference that is attached to the screening request. It enables you to trace and report on special requests through the system. This variable is provided for informational purposes only.
                  maxLength: 100
                chnEntity:
                  title: Entity Channel
                  type: string
                  description: Enables you to override the default screening channel for parties specified as "entity".
                  maxLength: 50
                chnUnknown:
                  title: Unknown Channel
                  type: string
                  description: Enables you to override the default screening channel for parties specified as "unknown".
                  maxLength: 50
                chnIndividual:
                  title: Individual Channel
                  type: string
                  description: Enables you to override the default screening channel for parties specified as "individual".
                  maxLength: 50
                wlpLastUpdated:
                  title: Watchlist Profile Last Updated
                  type: string
                  description: >
                    Enables you to screen incoming records against a delta of the watchlist, by the watchlist profile last updated date. Only the entities whose profiles have changed since a given date in the past (including that date) are screened.

                    Specify the value in ISO-8601 YYYY-MM-DD format.
                  maxLength: 10
                suppressAlertsFlg:
                  title: Suppress Alerts Flag
                  type: boolean
                  description: >
                    Enables you to manage requests for tuning purposes.

                    Valid values are as follows:
                      * true: Alerts are suppressed.
                      * false: Alerts are not suppressed.
                  default: false
                routingClassification:
                  title: Routing Classification
                  type: string
                  description: >
                    Enables you to override the default screening request routing classification. If no value is specified, a default routing classification is assigned: "batch" for Kafka messages and "real-time" for REST requests.
                  maxLength: 10
            notifications:
              title: Notifications
              description: All error and warning messages that are involved in the respective context of the screening process.
              type: object
              readOnly: true
              properties:
                errors:
                  title: Errors
                  description: Errors that occurred during processing.
                  type: array
                  maxItems: 50
                  items:
                    type: string
                    minLength: 0
                    maxLength: 500
                warnings:
                  title: Warnings
                  description: Warnings that occurred during processing.
                  type: array
                  maxItems: 50
                  items:
                    type: string
                    minLength: 0
                    maxLength: 500
            party:
              title: Party
              description: A list of entities and, for each entity, the information that is required to process the screening request.
              type: array
              minItems: 1
              maxItems: 10000
              items:
                type: object
                required:
                  - identifier
                properties:
                  identifier:
                    title: Identifier
                    type: string
                    description: The unique identifier that is associated with an individual entity in the screening request. This field is required and must be between 5 and 100 characters in length.
                    minLength: 5
                    maxLength: 100
                  identifierDesc:
                    title: Identifier Description
                    type: string
                    description: A description to attach to the unique identifier for categorization purposes.
                    maxLength: 20
                  category:
                    title: Category
                    type: string
                    description: The category of the entity being screened.
                    maxLength: 36
                  type:
                    title: Type
                    type: string
                    enum:
                      - individual
                      - entity
                      - unknown
                    description: The type of entity being screened. If not specified or a value other than "individual", "entity" or "unknown" is supplied, the record is processed using "unknown".
                    maxLength: 10
                  gender:
                    title: Gender
                    type: string
                    enum:
                      - male
                      - female
                      - other
                    default: other
                    description: The gender of the entity being screened. This field is used only when the type of entity being screened is "individual". If not specified or a value other than "male", "female" or "other" is supplied, the record is processed using "other".
                    maxLength: 10
                  name:
                    title: Name
                    type: string
                    description: >
                      The name of the entity being screened. If this field is not specified, the surname field must be included in the request.

                      If it is specified, the surname and firstName fields are ignored.

                      The value must be at least 2 characters and not more than 220 characters.

                      For individuals, the value is interpreted as a comma-delimited list of "surname, first name".
                    minLength: 2
                    maxLength: 220
                  firstName:
                    title: First Name
                    type: string
                    description: The first name of the entity being screened. This field is optional.
                    minLength: 2
                    maxLength: 100
                  surname:
                    title: Surname
                    type: string
                    description: >
                      The surname of the entity being screened. If name is not supplied, this field is required.

                      If used with firstName, the two fields are combined to form the full name of the entity.

                      The value must be at least 2 characters and not more than 100 characters.
                    minLength: 2
                    maxLength: 100
                  dateOfBirth:
                    title: Date of Birth
                    type: array
                    maxItems: 100
                    description: >
                      A list of supplied birthdate information for the entity being screened. This object is used only when the type of entity being screened is "individual".

                      * If the birthtDt field is supplied, the birthDay, birthMonth, and birthYear fields are not used in the screening request.

                      * If the birthDt field is not supplied, an attempt is made to interpret the birthDay, birthMonth, and birthYear as a date, and use that in the screening request.

                      * If the birthDay or birthMonth are not specified, only the birthYear is used in the screening request.
                    items:
                      type: object
                      properties:
                        birthDt:
                          title: Date of Birth
                          type: string
                          description: The birthdate, in ISO-8601 YYYY-MM-DD format, of the entity being screened. If provided, this field must be valid for the screening request to succeed.
                          maxLength: 10
                        birthDay:
                          title: Day of Birth
                          type: integer
                          description: The numeric birth day of the month for the entity being screened. This field can be used in combination with birthMonth and birthYear.
                        birthMonth:
                          title: Month of Birth
                          type: integer
                          description: The numeric birth month for the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthYear.
                        birthYear:
                          title: Year of Birth
                          type: integer
                          description: The birth year of the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthMonth.
                  address:
                    title: Address
                    type: array
                    maxItems: 100
                    description: A list of addresses that are associated with the entity that is being screened.
                    items:
                      type: object
                      required:
                        - countryCode
                      properties:
                        category:
                          title: Address Category
                          type: string
                          enum:
                            - pob
                            - address
                            - other
                          default: other
                          description: The category for this address. If not specified, or a value other than "pob" (place of birth), "address" or "other" is supplied, the record is processed using "other".
                          maxLength: 36
                        name:
                          title: Address Name
                          type: string
                          description: The name of the address, such as a house name.
                          maxLength: 36
                        number:
                          title: Address Number
                          type: string
                          description: The address number, such as a house number or post office box number.
                          maxLength: 36
                        lastChangeDt:
                          title: Address Last Changed Date
                          type: string
                          description: The last known date that the address for this entity was changed.
                          maxLength: 10
                        region:
                          title: Address Region
                          type: string
                          description: The region of the area in which the entity is located.
                          maxLength: 100
                        type:
                          title: Address Type
                          type: string
                          description: The type of address being used, such as home address or shipping address.
                          maxLength: 36
                        county:
                          title: Address County
                          type: string
                          description: The county in which the entity is located.
                          maxLength: 100
                        city:
                          title: Address City
                          type: string
                          description: The city in which the entity is located.
                          maxLength: 100
                        street:
                          title: Address Street
                          type: string
                          description: The street on which the entity is located.
                          maxLength: 100
                        buildingNumber:
                          title: Address Building Number
                          type: string
                          description: The number of the building at which the entity is located.
                          maxLength: 36
                        buildingName:
                          title: Address Building Name
                          type: string
                          description: The name of the building at which the entity is located.
                          maxLength: 50
                        floor:
                          title: Address Floor
                          type: string
                          description: The floor number on which the entity is located.
                          maxLength: 36
                        state:
                          title: Address State
                          type: string
                          description: The code or name of the state in which the entity is located.
                          maxLength: 100
                        countryCode:
                          title: Address Country Code
                          type: string
                          description: The ISO 3166 alphabetic code of the country in which the entity is located. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                          minLength: 2
                          maxLength: 3
                        postcode:
                          title: Address Postcode
                          type: string
                          description: The postcode or ZIP code in which the entity is located.
                          maxLength: 36
                        postBox:
                          title: Address Post Box
                          type: string
                          description: The post box number that is associated with the address.
                          maxLength: 10
                        full:
                          title: Full Address
                          type: string
                          description: The full address in which the entity is located.
                          maxLength: 500
                  identity:
                    title: Identity
                    type: array
                    maxItems: 100
                    description: The attributes that correspond to an entity's proof of identity.
                    items:
                      type: object
                      required:
                        - number
                      properties:
                        number:
                          title: Identity Number
                          type: string
                          description: The identifying number that is associated with the supplied form of identification for the entity. If a form of identity is provided, this field is required and must be valid for the screening request to succeed.
                          maxLength: 100
                        countryOfIssue:
                          title: Country of Issue (ISO)
                          type: integer
                          description: The numeric ISO code of the country that is associated with the supplied form of identification for the entity.
                        countryOfIssueCode:
                          title: Country of Issue Code
                          type: string
                          description: The ISO 3166 alphabetic code of the country that is associated with the supplied form of identification for the entity. This can be an Alpha-2 or Alpha-3 code.
                          maxLength: 3
                        dateOfIssue:
                          title: Date of Issue
                          type: string
                          description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                          maxLength: 10
                        dateOfExpiry:
                          title: Date of Expiry
                          type: string
                          description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                          maxLength: 10
                        validFrom:
                          title: Valid From
                          type: string
                          description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                          maxLength: 10
                        validTo:
                          title: Valid To
                          type: string
                          description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                          maxLength: 10
                        type:
                          title: Identity Type
                          type: string
                          description: The type of identification that is supplied.
                          maxLength: 36
                        issuedBy:
                          title: Issued By
                          type: string
                          description: The entity that issued the identification.
                          maxLength: 36
                        details:
                          title: Identity Details
                          type: string
                          description: Additional details for this form of identification.
                          maxLength: 100
                  alert:
                    title: Alert
                    type: object
                    description: All of the alert information that is involved in the respective context of this party.
                    readOnly: true
                    properties:
                      screeningOutcome:
                        title: Screening Outcome
                        type: string
                        minLength: 1
                        maxLength: 10
                        description: The alert type outcome that is captured for a screening process. Possible values are Alerted, Excluded, and Suppressed.
                        enum:
                          - No Alert
                          - Alerted
                          - Excluded
                          - Suppressed
                      comment:
                        title: Comment
                        type: string
                        minLength: 0
                        maxLength: 100
                        description: The comment that is captured from the rule that is responsible for generating or suppressing an alert.
                      type:
                        title: Type
                        type: string
                        minLength: 0
                        maxLength: 100
                        description: The alert type that is computed from the matched profiles. This field is set by the SAS Detection Definition rules when alert recommendations are generated.
                  screeningResult:
                    title: Screening Result
                    type: object
                    readOnly: true
                    description: The result of a screening.
                    properties:
                      notifications:
                        $ref: "#/components/schemas/entityScreening/properties/message/properties/notifications"
                      statusCode:
                        title: Status Code
                        type: string
                        enum:
                          - Success
                          - Warning
                          - Validation Failure
                          - Failure
                        description: >-
                          The status of a screening request at the record level.

                          * Success: screening successful.

                          * Warning: screening successful with warnings

                          * Validation Failure: screening request failure

                          * Failure: screening response failure
                        minLength: 7
                        maxLength: 18
                        readOnly: true
                      hits:
                        title: Hits
                        type: integer
                        description: The number of hits against the entity that occurred during the screening request.
                        readOnly: true
                      discardedHits:
                        title: Discarded Hits
                        type: integer
                        description: The number of discarded hits against the entity that occurred during the screening request as a result of a screening exception.
                        readOnly: true
                      remainingHits:
                        title: Remaining Hits
                        type: integer
                        description: The total number of unique hits. This is calculated by subtracting the number of 'discardedHits' from the total number of 'hits'.
                        readOnly: true
                      maxScore:
                        title: Maximum Score
                        type: integer
                        description: For the screened entity, the highest matchProfile.score of all of the matchedProfile records.
                        readOnly: true
                      primaryName:
                        title: Primary Name
                        type: string
                        description: For the screened entity, the matchedProfile.primaryName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                        readOnly: true
                        maxLength: 50
                      matchedName:
                        title: Matched name
                        type: string
                        description: For the screened entity, the matchedProfile.matchedName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                        readOnly: true
                        maxLength: 50
                      maxProximityScore:
                        title: Maximum Proximity Score
                        type: integer
                        description: For the screened entity, the highest matchProfile.proximityScore of all of the matchedProfile records.
                        readOnly: true
                      tags:
                        title: Tags
                        type: array
                        maxItems: 20
                        description: The unique set of tags associated with all of the active matchedProfile records.
                        readOnly: true
                        items:
                          type: string
                          minLength: 1
                          maxLength: 4
                      messageReference:
                        title: Message Reference
                        type: string
                        description: The unique identifier that is generated by SAS Real-Time Watchlist Screening for a screening request. This value is populated in the screening response and is ignored on input.
                        minLength: 0
                        maxLength: 36
                        readOnly: true
                      matchedProfile:
                        title: Matched Profile
                        type: array
                        maxItems: 1000
                        description: The outcome data that is received from the watchlist screening engine when a hit occurs. This data is utilized in the alert generation process.
                        readOnly: true
                        items:
                          type: object
                          properties:
                            score:
                              title: Score
                              type: integer
                              description: Indicates the confidence level of the match.
                              readOnly: true
                            level:
                              title: Level
                              type: string
                              description: >
                                The strength of the hit. This is based on the elements that have matched (such as name, city, country, gender, DOB, ID). If a match occurs

                                only on name, the level is always "low". Otherwise, the level corresponds to the highest level assigned to the matched criteria as defined

                                in the metadata policies. If the match was ignored as a result of a screening exception, the level value is set to "discarded".
                              minLength: 1
                              maxLength: 10
                              readOnly: true
                            profileId:
                              title: Profile ID
                              type: string
                              description: The ID that is returned from the watchlist provider.
                              minLength: 1
                              maxLength: 100
                              readOnly: true
                            checksum:
                              title: Checksum
                              type: integer
                              description: A hash of the entire watchlist profile. This enables you to verify the value against your alerts database to determine whether it has changed.
                              readOnly: true
                            coreChecksum:
                              title: Core Checksum
                              type: integer
                              description: >
                                The checksum value that is associated with the subset of profile data that constitutes important information. This changes only when properties that

                                are part of the screening logic are changed. This includes names, addresses, IDs, date of birth, sanctions, and status.
                              readOnly: true
                            proximityScore:
                              title: Proximity Score
                              type: integer
                              description: >-
                                The proximity score with respect to a profile that is published by a watchlist.


                                This attribute indicates how close a watchlist entry is to a sanctioned watchlist profile. Possible values include:


                                100 - sanctioned profile


                                80 - direct relationship with sanctioned profile


                                50 - one relationship removed from a sanctioned profile


                                0 - no relationship found


                                null - undefined


                                Note that all private list matches are returned as null (undefined).
                              readOnly: true
                            tags:
                              title: Tags
                              type: array
                              maxItems: 20
                              description: >-
                                Tags are used to indicate the type of list in which the record resides. It can also be used to indicate the entity type for the record.


                                **List Types**:


                                SAN = Sanctions Lists


                                SIE = Special Interest Entity


                                SIP = Special Interest Person


                                PEP = Politically Exposed Person


                                RCA = Relative or Close Associate


                                SOC = State Owned Company


                                OOL = Other Official Lists


                                AM = Adverse Media


                                BRD = Board Member


                                **Entity Types**:


                                LOC = Risk country


                                VSL = Vessels


                                AIR = Aircrafts


                                For **Dow Jones Factiva**, see Description 1, Description 2, and Description 3.


                                For **Refinitiv World-Check**, see Category and Sub-category.
                              items:
                                type: string
                                minLength: 1
                                maxLength: 4
                              readOnly: true
                            categories:
                              title: Categories
                              type: array
                              description: The list of categories assigned to the profile that is returned from the watchlist provider.
                              maxItems: 50
                              items:
                                type: string
                                minLength: 1
                                maxLength: 50
                              readOnly: true
                            scoreScope:
                              title: Score Scope
                              type: array
                              maxItems: 50
                              description: The list of matched metadata attributes such as DOB, city, country, gender, and ID.
                              items:
                                type: string
                                minLength: 1
                                maxLength: 50
                              readOnly: true
                            matchedName:
                              title: Matched Name
                              type: string
                              description: The name that matches the profile's primary name or one of its aliases.
                              minLength: 1
                              maxLength: 50
                              readOnly: true
                            screened:
                              title: Screened
                              type: string
                              description: >
                                The text in the request in which the match was found. When screening names, this should be the same as the input string. When

                                screening texts, this is a snippet containing the matched name.
                              minLength: 1
                              maxLength: 50
                              readOnly: true
                            matchType:
                              title: Match Type
                              type: string
                              description: Provides an indication as to the basis of the type of matched data (name, ID, address, currency, country, web, etc.).
                              minLength: 1
                              maxLength: 25
                              readOnly: true
                              enum:
                                - /name/primary
                                - /name/alias
                                - /name/web
                                - /address
                                - /geo/country/iso
                                - /geo/country/name
                                - /geo/country/currency
                                - /geo/city
                                - /geo/city/capital
                                - /geo/district
                                - /id/bic
                                - /id/imo
                                - /id/isin
                                - /id/passport
                                - /id/driving_licence
                                - /id/national_id
                                - /id/other/bic
                                - /id/other/imo
                                - /id/other/isin
                                - /id/other/passport
                                - /id/other/driving_licence
                                - /id/other/national_id
                            primaryName:
                              title: Primary Name
                              type: string
                              description: The primary name of the matched profile.
                              minLength: 1
                              maxLength: 50
                              readOnly: true
                            profileType:
                              title: Profile Type
                              type: string
                              description: The type of profile matched such as "individual", "entity", or "vessel".
                              minLength: 1
                              maxLength: 15
                              readOnly: true
                            sanctions:
                              title: Sanctions
                              type: array
                              maxItems: 50
                              description: The unique code of all the sanction lists in which this profile appears. These codes can be used in the "sanctions" preset field.
                              items:
                                type: string
                                minLength: 1
                                maxLength: 20
                              readOnly: true
                            profileGender:
                              title: Profile Gender
                              type: string
                              description: The gender of the matched profile, if known. Applies only for individuals.
                              minLength: 1
                              maxLength: 10
                              readOnly: true
                            dateOfBirth:
                              title: Date of Birth
                              type: array
                              maxItems: 100
                              description: The data provided about dates of birth.
                              readOnly: true
                              items:
                                type: object
                                properties:
                                  birthDt:
                                    title: Date of Birth
                                    type: string
                                    description: The date of birth in ISO-8601 YYYY-MM-DD format.
                                    maxLength: 10
                                  birthDay:
                                    title: Day of Birth
                                    type: integer
                                    description: The day of birth.
                                  birthMonth:
                                    title: Month of Birth
                                    type: integer
                                    description: The month of birth.
                                  birthYear:
                                    title: Year of Birth
                                    type: integer
                                    description: The year of birth.
                            profileBirthPlaces:
                              title: Profile Birth Places
                              type: array
                              maxItems: 100
                              description: The data provided about birth places such as city and country.
                              items:
                                type: object
                                properties:
                                  city:
                                    title: City
                                    type: string
                                    description: The city in which the matched entity was born.
                                    minLength: 0
                                    maxLength: 100
                                  countryCode:
                                    title: Country Code
                                    type: string
                                    description: The country in which the matched entity was born (ISO2 code).
                                    minLength: 0
                                    maxLength: 2
                              readOnly: true
                            profilePlaces:
                              title: Profile Places
                              type: array
                              maxItems: 100
                              description: The data provided about the location of the matched entity such as city and country.
                              items:
                                type: object
                                properties:
                                  city:
                                    title: City
                                    type: string
                                    description: The city in which the matched entity is located.
                                    minLength: 0
                                    maxLength: 100
                                  countryCode:
                                    title: Country Code
                                    type: string
                                    description: The country in which the matched entity is located (ISO2 code).
                                    minLength: 0
                                    maxLength: 2
                              readOnly: true
                            profileIds:
                              title: Profile IDs
                              type: array
                              maxItems: 50
                              description: The list of all the IDs found in the profile that can potentially be matched with the IDs sent in the screened metadata.
                              items:
                                type: string
                                minLength: 1
                                maxLength: 50
                              readOnly: true
                            profileRelatedCountries:
                              title: Profile Related Countries
                              type: array
                              maxItems: 50
                              description: Other related countries of the matched profile (citizenships, incorporation, etc.).
                              items:
                                type: string
                                minLength: 1
                                maxLength: 20
                              readOnly: true
                            profileStatus:
                              title: Profile Status
                              type: string
                              description: The status of the matched watchlist profile. The values indicate whether the record is active, inactive, deceased, or unknown.
                              minLength: 1
                              maxLength: 3
                              enum:
                                - ACT
                                - INA
                                - DEC
                                - UNK
                              readOnly: true
                            profileLastUpdated:
                              title: Profile Last Updated
                              type: string
                              description: The timestamp of the profile's last update, in date-time format (RFC 3339).
                              format: date-time
                              minLength: 1
                              maxLength: 24
                              readOnly: true
                            exceptionId:
                              title: Exception ID
                              type: string
                              description: The ID that is returned against an exception that is found and applied to a match. This internal ID is returned by the watchlist screening engine.
                              minLength: 0
                              maxLength: 50
                              readOnly: true
                            exceptionReference:
                              title: Exception Reference
                              description: The reference ID that is associated with the exception. This is an internal identifier that is assigned when the exception is created.
                              type: string
                              minLength: 0
                              maxLength: 200
                              readOnly: true
                            locationPath:
                              title: Location Path
                              description: In a complex screened object (text or transaction), an indication as to where a match was found. For entity screening, the value is always '/'. For payment screening, the value is a screened field (such as '/debtor/name').
                              type: string
                              minLength: 0
                              maxLength: 200
                              readOnly: true
                            locationFrom:
                              title: Location From
                              description: In screened text, the 0-based start position where the match was found.
                              type: integer
                              readOnly: true
                            locationTo:
                              title: Location To
                              description: In screened text, the 0-based end position where the match was found.
                              type: integer
                              readOnly: true
                            mediaAgeScore:
                              title: Media Age Score
                              description: A score that indicates the age of the adverse media articles that are found in a profile.
                              type: integer
                              readOnly: true
                            mediaQuantityScore:
                              title: Media Quantity Score
                              description: A score that indicates the number of adverse media articles that were found in a watchlist profile as compared to the average number of adverse media reports for all profiles.
                              type: integer
                              readOnly: true
                            alert:
                              title: Alert
                              type: object
                              description: All of the alert information that is involved in the respective context of this matched profile.
                              readOnly: true
                              properties:
                                screeningOutcome:
                                  title: Screening Outcome
                                  type: string
                                  minLength: 1
                                  maxLength: 10
                                  description: The alert type outcome that is captured for a screening process. Possible values are Alerted, Excluded, and Suppressed.
                                  enum:
                                    - No Alert
                                    - Alerted
                                    - Excluded
                                    - Suppressed
                                comment:
                                  title: Comment
                                  type: string
                                  minLength: 0
                                  maxLength: 100
                                  description: The comment that is captured from the rule that is responsible for generating or suppressing an alert.
                                type:
                                  title: Type
                                  type: string
                                  nullable: true
                                  minLength: 0
                                  maxLength: 100
                                  description: The alert type that is computed from the matched profiles. This field is set by the SAS Detection Definition rules when alert recommendations are generated.
                            links:
                              title: Links
                              type: array
                              description: The links to the watchlist profile resource and, if applicable, the screening exception resource that are related to the matched profile.
                              maxItems: 2
                              items:
                                $ref: "#/components/schemas/preset/properties/links/items"
                              readOnly: true
    paymentScreening:
      description: The collection of objects that are required to screen a payment. This is the default configuration. This request is based on a message schema and might change after deployment.
      properties:
        message:
          properties:
            notifications:
              description: All error and warning messages that are involved in the respective context of the screening process.
              properties:
                errors:
                  description: Errors that occurred during processing.
                  items:
                    maxLength: 500
                    type: string
                  maxItems: 50
                  title: Errors
                  type: array
                warnings:
                  description: Warnings that occurred during processing.
                  items:
                    maxLength: 500
                    type: string
                  maxItems: 50
                  title: Warnings
                  type: array
              readOnly: true
              title: Notifications
              type: object
            payment:
              description: A list of payments and, for each payment, the information that is required to process the screening request.
              items:
                properties:
                  amount:
                    description: The amount of the payment. Use a dot (.) as the decimal separator, for example, 3445.68.
                    title: Amount
                    type: number
                  creditor:
                    description: Creditor information.
                    properties:
                      account:
                        description: Incoming data from the customers that contain information that is related to a transaction.
                        properties:
                          currency:
                            description: The 3-digit alphabetic ISO currency code that is associated with the account.
                            maxLength: 3
                            minLength: 3
                            title: Currency
                            type: string
                          name:
                            description: The name of the account, as assigned by the account servicing institution. This provides an additional means of identification for the account.
                            maxLength: 200
                            minLength: 2
                            title: Name
                            type: string
                          number:
                            description: The unique identifier that is associated with the account. This field is required and must be between 1 and 100 characters in length.
                            maxLength: 100
                            minLength: 1
                            title: Account Number
                            type: string
                          proxy:
                            description: An alternate assumed name for the identification of the account.
                            maxLength: 200
                            title: Proxy
                            type: string
                          type:
                            description: The type of the account (for example, savings, checking, and so on).
                            maxLength: 200
                            title: Account Type
                            type: string
                        required:
                          - number
                        title: Account
                        type: object
                      dateOfBirth:
                        description: >-
                          A supplied birthdate for the entity being screened. This object is used only when the type of entity being screened is "individual".

                          * If the birthtDt field is supplied, the birthDay, birthMonth, and birthYear fields are not used in the screening request.

                          * If the birthDt field is not supplied, an attempt is made to interpret the birthDay, birthMonth, and birthYear as a date, and use that in the screening request.

                          * If the birthDay or birthMonth are not specified, only the birthYear is used in the screening request.
                        properties:
                          birthDay:
                            description: The numeric birth day of the month for the entity being screened. This field can be used in combination with birthMonth and birthYear.
                            title: Day of Birth
                            type: integer
                          birthDt:
                            description: The birthdate, in ISO-8601 YYYY-MM-DD format, of the entity being screened. If provided, this field must be valid for the screening request to succeed.
                            maxLength: 10
                            title: Date of Birth
                            type: string
                          birthMonth:
                            description: The numeric birth month for the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthYear.
                            title: Month of Birth
                            type: integer
                          birthYear:
                            description: The birth year of the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthMonth.
                            title: Year of Birth
                            type: integer
                        title: Date of Birth
                        type: object
                      firstName:
                        description: The first name or names of the party.
                        maxLength: 100
                        minLength: 2
                        title: First Name
                        type: string
                      gender:
                        description: For an individual party, the gender of the person.  If not specified or an unexpected value is supplied, the record is processed using "other". Valid values are "male", "female", and "other".
                        maxLength: 10
                        title: Gender
                        type: string
                      identity:
                        description: The attributes that correspond to an entity's proof of identity.
                        items:
                          properties:
                            countryOfIssue:
                              description: The numeric ISO code of the country that is associated with the supplied form of identification for the entity.
                              title: Country of Issue (ISO)
                              type: integer
                            countryOfIssueCode:
                              description: The ISO 3166 alphabetic code of the country that is associated with the supplied form of identification for the entity. This can be an Alpha-2 or Alpha-3 code.
                              maxLength: 3
                              title: Country of Issue Code
                              type: string
                            dateOfExpiry:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Expiry
                              type: string
                            dateOfIssue:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Issue
                              type: string
                            details:
                              description: Additional details for this form of identification.
                              maxLength: 100
                              title: Identity Details
                              type: string
                            issuedBy:
                              description: The entity that issued the identification.
                              maxLength: 36
                              title: Issued By
                              type: string
                            number:
                              description: The identifying number that is associated with the supplied form of identification for the entity. If a form of identity is provided, this field is required and must be valid for the screening request to succeed.
                              maxLength: 100
                              minLength: 1
                              title: Identity Number
                              type: string
                            type:
                              description: The type of identification that is supplied.
                              maxLength: 36
                              title: Identity Type
                              type: string
                            validFrom:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid From
                              type: string
                            validTo:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid To
                              type: string
                          required:
                            - number
                          type: object
                        maxItems: 100
                        title: Identity
                        type: array
                      label:
                        description: An optional label that is used to help identify the party's role or map the party's role to the original transaction object.
                        maxLength: 200
                        title: Label
                        type: string
                      name:
                        description: >
                          The name of the entity being screened. If this field is specified,

                          the surname and firstName fields are ignored. The value must be at least 2 characters and not more than 220 characters. For individuals, the

                          value is interpreted as a comma-delimited list of "surname, first name".
                        maxLength: 220
                        minLength: 2
                        title: Name
                        type: string
                      placeOfBirth:
                        description: Incoming data from the customers that contain information related to the place of birth of a party that is involved in a transaction.
                        properties:
                          addressLines:
                            description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                            items:
                              maxLength: 500
                              type: string
                            title: Address Lines
                            type: array
                          city:
                            description: The city in which the party was born.
                            maxLength: 100
                            title: City
                            type: string
                          countryCode:
                            description: The alphabetic ISO 3166 code of the country in which the party was born. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                            maxLength: 3
                            minLength: 2
                            title: Country Code
                            type: string
                          postCode:
                            description: The postcode or ZIP code in which the party was born.
                            maxLength: 36
                            title: Address Postcode
                            type: string
                          state:
                            description: An optional code or name of the state in which the party was born.
                            maxLength: 100
                            title: State
                            type: string
                          text:
                            description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                            maxLength: 500
                            title: Text
                            type: string
                        required:
                          - countryCode
                        title: Place of Birth
                        type: object
                      postalAddress:
                        description: Incoming data from the customers that contain information related to the postal address of a party that is involved in a transaction.
                        items:
                          properties:
                            addressLines:
                              description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                              items:
                                maxLength: 500
                                type: string
                              title: Address Lines
                              type: array
                            city:
                              description: The city in which the party is located.
                              maxLength: 100
                              title: City
                              type: string
                            countryCode:
                              description: The alphabetic ISO 3166 code of the country in which the party is located. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                              maxLength: 3
                              minLength: 2
                              title: Country Code
                              type: string
                            postCode:
                              description: The postcode or ZIP code in which the party is located.
                              maxLength: 36
                              title: Address Postcode
                              type: string
                            state:
                              description: An optional code or name of the state in which the party is located.
                              maxLength: 100
                              title: State
                              type: string
                            text:
                              description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                              maxLength: 500
                              title: Text
                              type: string
                          type: object
                        maxItems: 100
                        required:
                          - countryCode
                        title: Postal Address
                        type: array
                      screeningResult:
                        description: The result of a screening.
                        properties:
                          discardedHits:
                            description: The number of discarded hits against the entity that occurred during the screening request as a result of a screening exception.
                            title: Discarded Hits
                            type: integer
                            readOnly: true
                          hits:
                            description: The number of hits against the entity that occurred during the screening request.
                            title: Hits
                            type: integer
                            readOnly: true
                          maxScore:
                            title: Maximum Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.score of all of the matchedProfile records.
                            readOnly: true
                          primaryName:
                            title: Primary Name
                            type: string
                            description: For the screened entity, the matchedProfile.primaryName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          matchedName:
                            title: Matched name
                            type: string
                            description: For the screened entity, the matchedProfile.matchedName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          maxProximityScore:
                            title: Maximum Proximity Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.proximityScore of all of the matchedProfile records.
                            readOnly: true
                          matchedProfile:
                            description: The outcome data that is received from the watchlist screening engine when a hit occurs. This data is utilized in the alert generation process.
                            items:
                              properties:
                                categories:
                                  description: The list of categories assigned to the profile that is returned from the watchlist provider.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Categories
                                  type: array
                                checksum:
                                  description: A hash of the entire watchlist profile. This enables you to verify the value against your alerts database to determine if it has changed.
                                  title: Checksum
                                  type: integer
                                coreChecksum:
                                  description: The checksum value that is associated with the subset of profile data that constitutes important information. This changes only when properties that are part of the screening logic are changed. This includes names, addresses, IDs, date of birth, sanctions, and status.
                                  title: Core Checksum
                                  type: integer
                                dateOfBirth:
                                  description: The data provided about dates of birth.
                                  items:
                                    properties:
                                      birthDay:
                                        description: The day of birth.
                                        title: Day of Birth
                                        type: integer
                                      birthDt:
                                        description: The date of birth in ISO-8601 YYYY-MM-DD format.
                                        maxLength: 10
                                        readOnly: true
                                        title: Date of Birth
                                        type: string
                                      birthMonth:
                                        description: The month of birth.
                                        title: Month of Birth
                                        type: integer
                                      birthYear:
                                        description: The year of birth.
                                        title: Year of Birth
                                        type: integer
                                    type: object
                                  maxItems: 100
                                  title: Date of Birth
                                  type: array
                                geoScore:
                                  title: Geo Score
                                  description: A value that indicates the geographic degree of correspondence between the screened entity and the matched profile. A value of 0 indicates that no evidence was found. A value above 50 indicates that at least one country reference was found. Additional references further increase the score.
                                  type: integer
                                  readOnly: true
                                geoClues:
                                  title: Geo Clues
                                  description: A list of geographic references to the countries in the matched profiles.
                                  type: array
                                  items:
                                    maxLength: 200
                                    minLength: 1
                                    type: string
                                  maxItems: 100
                                  readOnly: true
                                exceptionId:
                                  description: The ID that is returned against an exception that is found and applied to a match. This internal ID is returned by the watchlist screening engine.
                                  maxLength: 50
                                  readOnly: true
                                  title: Exception ID
                                  type: string
                                exceptionReference:
                                  title: Exception Reference
                                  description: The reference ID that is associated with the exception. This is an internal identifier that is assigned when the exception is created.
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationPath:
                                  title: Location Path
                                  description: In a complex screened object (text or transaction), an indication as to where a match was found. For entity screening, the value is always '/'. For payment screening, the value is a screened field (such as '/debtor/name').
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationFrom:
                                  title: Location From
                                  description: In screened text, the 0-based start position where the match was found.
                                  type: integer
                                  readOnly: true
                                locationTo:
                                  title: Location To
                                  description: In screened text, the 0-based end position where the match was found.
                                  type: integer
                                  readOnly: true
                                mediaAgeScore:
                                  title: Media Age Score
                                  description: A score that indicates the age of the adverse media articles that are found in a profile.
                                  type: integer
                                  readOnly: true
                                mediaQuantityScore:
                                  title: Media Quantity Score
                                  description: A score that indicates the number of adverse media articles that were found in a watchlist profile as compared to the average number of adverse media reports for all profiles.
                                  type: integer
                                  readOnly: true
                                level:
                                  description: The strength of the hit. This is based on the elements that have matched (such as name, city, country, gender, DOB, ID). If a match occurs only on name, the level is always "low". Otherwise, the level corresponds to the highest level assigned to the matched criteria as defined in the metadata policies. If the match was ignored as a result of a screening exception, the level value is set to "discarded".
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Level
                                  type: string
                                links:
                                  description: The links to the watchlist profile resource and, if applicable, the screening exception resource that are related to the matched profile.
                                  items:
                                    properties:
                                      href:
                                        description: The URL for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: HREF
                                        type: string
                                      itemType:
                                        description: If this is a link to a container, itemType is the media type or link type for the items in the container.
                                        maxLength: 200
                                        readOnly: true
                                        title: Item Type
                                        type: string
                                      method:
                                        description: The HTTP method for the link.
                                        maxLength: 6
                                        minLength: 1
                                        readOnly: true
                                        title: Method
                                        type: string
                                      rel:
                                        description: The relationship of the link to the resource.
                                        maxLength: 50
                                        minLength: 1
                                        readOnly: true
                                        title: Relation Type
                                        type: string
                                      responseItemType:
                                        description: The media type or link type of the items in the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Item Type
                                        type: string
                                      responseType:
                                        description: The media type or link type of the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Type
                                        type: string
                                      title:
                                        description: The title for the link.
                                        maxLength: 100
                                        readOnly: true
                                        title: Title
                                        type: string
                                      type:
                                        description: The media type or link type for the link.
                                        maxLength: 200
                                        readOnly: true
                                        title: Media Type
                                        type: string
                                      uri:
                                        description: The relative URI for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: URI
                                        type: string
                                    type: object
                                  maxItems: 2
                                  required:
                                    - rel
                                  title: Links
                                  type: array
                                matchType:
                                  description: Provides an indication as to the basis of the type of matched data (name, ID, address, currency, country, web, etc.).
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Match Type
                                  type: string
                                matchedName:
                                  description: The name that matches the profile's primary name or one of its aliases.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Matched Name
                                  type: string
                                primaryName:
                                  description: The primary name of the matched profile.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Primary Name
                                  type: string
                                profileBirthPlaces:
                                  description: The data provided about birth places such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity was born.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity was born (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Birth Places
                                  type: array
                                profileGender:
                                  description: The gender of the matched profile, if known. Applies only for individuals.
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Gender
                                  type: string
                                profileId:
                                  description: The ID that is returned from the watchlist provider.
                                  maxLength: 100
                                  minLength: 1
                                  readOnly: true
                                  title: Profile ID
                                  type: string
                                profileIds:
                                  description: The list of all the IDs found in the profile that can potentially be matched with the IDs sent in the screened metadata.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile IDs
                                  type: array
                                profileLastUpdated:
                                  description: The timestamp of the profile's last update, in date-time format (RFC 3339).
                                  maxLength: 24
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Last Updated
                                  type: string
                                profilePlaces:
                                  description: The data provided about the location of the matched entity such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity is located.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity is located (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Places
                                  type: array
                                profileRelatedCountries:
                                  description: Other related countries of the matched profile (citizenships, incorporation, etc.).
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile Related Countries
                                  type: array
                                profileStatus:
                                  description: The status of the matched watchlist profile. The values indicate whether the record is active, inactive, deceased, or unknown.
                                  maxLength: 3
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Status
                                  type: string
                                profileType:
                                  description: The type of profile matched such as "individual", "entity", or "vessel".
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Type
                                  type: string
                                proximityScore:
                                  description: >-
                                    The proximity score with respect to a profile that is published by a watchlist.


                                    This attribute indicates how close a watchlist entry is to a sanctioned watchlist profile. Possible values include:


                                    100 - sanctioned profile


                                    80 - direct relationship with sanctioned profile


                                    50 - one relationship removed from a sanctioned profile


                                    0 - no relationship found


                                    null - undefined


                                    Note that all private list matches are returned as null (undefined).
                                  title: Proximity Score
                                  type: integer
                                  nullable: true
                                sanctions:
                                  description: The unique code of all the sanction lists in which this profile appears. These codes can be used in the "sanctions" preset field.
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Sanctions
                                  type: array
                                score:
                                  description: Indicates the confidence level of the match.
                                  title: Score
                                  type: integer
                                scoreScope:
                                  description: The list of matched metadata attributes such as DOB, city, country, gender, and ID.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Score Scope
                                  type: array
                                screened:
                                  description: >
                                    The text in the request in which the match was found. When screening names, this should be the same as the input string.

                                    When screening texts, this is a snippet containing the matched name.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Screened
                                  type: string
                                tags:
                                  description: >-
                                    Tags are used to indicate the type of list in which the record resides. It can also be used to indicate the entity type for the record.


                                    **List Types**:


                                    SAN = Sanctions Lists


                                    SIE = Special Interest Entity


                                    SIP = Special Interest Person


                                    PEP = Politically Exposed Person


                                    RCA = Relative or Close Associate


                                    SOC = State Owned Company


                                    OOL = Other Official Lists


                                    AM = Adverse Media


                                    BRD = Board Member


                                    **Entity Types**:


                                    LOC = Risk country


                                    VSL = Vessels


                                    AIR = Aircrafts


                                    For **Dow Jones Factiva**, see Description 1, Description 2, and Description 3.


                                    For **Refinitiv World-Check**, see Category and Sub-category.
                                  items:
                                    maxLength: 4
                                    minLength: 1
                                    type: string
                                  maxItems: 20
                                  title: Tags
                                  type: array
                              type: object
                            maxItems: 1000
                            title: Matched Profile
                            type: array
                            readOnly: true
                          messageReference:
                            description: The unique identifier that is generated by SAS Real-Time Watchlist Screening for a screening request. This value is populated in the screening response and is ignored on input.
                            maxLength: 36
                            minLength: 0
                            readOnly: true
                            title: Message Reference
                            type: string
                          statusCode:
                            description: >-
                              The status of a screening request at the record level.
                               •  Success = screening successful
                               •  Warning = screening successful with warnings
                               •  Validation Failure = screening request failure
                               •  Failure = screening response failure
                            maxLength: 18
                            minLength: 7
                            readOnly: true
                            title: Status Code
                            type: string
                        readOnly: true
                        title: Screening Result
                        type: object
                      surname:
                        description: The surname of the entity being screened. If used with firstName, the two fields are combined to form the full name of the entity. The value must be at least 2 characters and not more than 100 characters.
                        maxLength: 100
                        minLength: 2
                        title: Surname
                        type: string
                      text:
                        description: The party information as unstructured data.  If the name field is specified, this field is ignored.
                        maxLength: 1000
                        title: Text
                        type: string
                    title: Creditor
                    type: object
                  creditorAgent:
                    description: Creditor agent information.
                    properties:
                      account:
                        description: Incoming data from the customers that contain information that is related to a transaction.
                        properties:
                          currency:
                            description: The 3-digit alphabetic ISO currency code that is associated with the account.
                            maxLength: 3
                            minLength: 3
                            title: Currency
                            type: string
                          name:
                            description: The name of the account, as assigned by the account servicing institution. This provides an additional means of identification for the account.
                            maxLength: 200
                            title: Name
                            type: string
                          number:
                            description: The unique identifier that is associated with the account. This field is required and must be between 1 and 100 characters in length.
                            maxLength: 100
                            minLength: 1
                            title: Account Number
                            type: string
                          proxy:
                            description: An alternate assumed name for the identification of the account.
                            maxLength: 200
                            title: Proxy
                            type: string
                          type:
                            description: The type of the account (for example, savings, checking, and so on).
                            maxLength: 200
                            title: Account Type
                            type: string
                        required:
                          - number
                        title: Account
                        type: object
                      dateOfBirth:
                        description: >-
                          A supplied birthdate for the entity being screened. This object is used only when the type of entity being screened is "individual".

                          * If the birthtDt field is supplied, the birthDay, birthMonth, and birthYear fields are not used in the screening request.

                          * If the birthDt field is not supplied, an attempt is made to interpret the birthDay, birthMonth, and birthYear as a date, and use that in the screening request.

                          * If the birthDay or birthMonth are not specified, only the birthYear is used in the screening request.
                        properties:
                          birthDay:
                            description: The numeric birth day of the month for the entity being screened. This field can be used in combination with birthMonth and birthYear.
                            title: Day of Birth
                            type: integer
                          birthDt:
                            description: The birthdate, in ISO-8601 YYYY-MM-DD format, of the entity being screened. If provided, this field must be valid for the screening request to succeed.
                            maxLength: 10
                            title: Date of Birth
                            type: string
                          birthMonth:
                            description: The numeric birth month for the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthYear.
                            title: Month of Birth
                            type: integer
                          birthYear:
                            description: The birth year of the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthMonth.
                            title: Year of Birth
                            type: integer
                        title: Date of Birth
                        type: object
                      firstName:
                        description: The first name or names of the party.
                        maxLength: 100
                        minLength: 2
                        title: First Name
                        type: string
                      gender:
                        description: For an individual party, the gender of the person.  If not specified or an unexpected value is supplied, the record is processed using "other". Valid values are "male", "female", and "other".
                        maxLength: 10
                        title: Gender
                        type: string
                      identity:
                        description: The attributes that correspond to an entity's proof of identity.
                        items:
                          properties:
                            countryOfIssue:
                              description: The numeric ISO code of the country that is associated with the supplied form of identification for the entity.
                              title: Country of Issue (ISO)
                              type: integer
                            countryOfIssueCode:
                              description: The ISO 3166 alphabetic code of the country that is associated with the supplied form of identification for the entity. This can be an Alpha-2 or Alpha-3 code.
                              maxLength: 3
                              title: Country of Issue Code
                              type: string
                            dateOfExpiry:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Expiry
                              type: string
                            dateOfIssue:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Issue
                              type: string
                            details:
                              description: Additional details for this form of identification.
                              maxLength: 100
                              title: Identity Details
                              type: string
                            issuedBy:
                              description: The entity that issued the identification.
                              maxLength: 36
                              title: Issued By
                              type: string
                            number:
                              description: The identifying number that is associated with the supplied form of identification for the entity. If a form of identity is provided, this field is required and must be valid for the screening request to succeed.
                              maxLength: 100
                              minLength: 1
                              title: Identity Number
                              type: string
                            type:
                              description: The type of identification that is supplied.
                              maxLength: 36
                              title: Identity Type
                              type: string
                            validFrom:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid From
                              type: string
                            validTo:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid To
                              type: string
                          required:
                            - number
                          type: object
                        maxItems: 100
                        title: Identity
                        type: array
                      label:
                        description: An optional label that is used to help identify the party's role or map the party's role to the original transaction object.
                        maxLength: 200
                        title: Label
                        type: string
                      name:
                        description: >
                          The name of the entity being screened. If this field is specified,

                          the surname and firstName fields are ignored. The value must be at least 2 characters and not more than 220 characters. For individuals, the

                          value is interpreted as a comma-delimited list of "surname, first name".
                        maxLength: 220
                        minLength: 2
                        title: Name
                        type: string
                      placeOfBirth:
                        description: Incoming data from the customers that contain information related to the place of birth of a party that is involved in a transaction.
                        properties:
                          addressLines:
                            description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                            items:
                              maxLength: 500
                              type: string
                            title: Address Lines
                            type: array
                          city:
                            description: The city in which the party was born.
                            maxLength: 100
                            title: City
                            type: string
                          countryCode:
                            description: The alphabetic ISO 3166 code of the country in which the party was born. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                            maxLength: 3
                            minLength: 2
                            title: Country Code
                            type: string
                          postCode:
                            description: The postcode or ZIP code in which the party was born.
                            maxLength: 36
                            title: Address Postcode
                            type: string
                          state:
                            description: An optional code or name of the state in which the party was born.
                            maxLength: 100
                            title: State
                            type: string
                          text:
                            description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                            maxLength: 500
                            title: Text
                            type: string
                        required:
                          - countryCode
                        title: Place of Birth
                        type: object
                      postalAddress:
                        description: Incoming data from the customers that contain information related to the postal address of a party that is involved in a transaction.
                        items:
                          properties:
                            addressLines:
                              description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                              items:
                                maxLength: 500
                                type: string
                              title: Address Lines
                              type: array
                            city:
                              description: The city in which the party is located.
                              maxLength: 100
                              title: City
                              type: string
                            countryCode:
                              description: The alphabetic ISO 3166 code of the country in which the party is located. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                              maxLength: 3
                              minLength: 2
                              title: Country Code
                              type: string
                            postCode:
                              description: The postcode or ZIP code in which the party is located.
                              maxLength: 36
                              title: Address Postcode
                              type: string
                            state:
                              description: An optional code or name of the state in which the party is located.
                              maxLength: 100
                              title: State
                              type: string
                            text:
                              description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                              maxLength: 500
                              title: Text
                              type: string
                          type: object
                        maxItems: 100
                        required:
                          - countryCode
                        title: Postal Address
                        type: array
                      screeningResult:
                        description: The result of a screening.
                        properties:
                          discardedHits:
                            description: The number of discarded hits against the entity that occurred during the screening request as a result of a screening exception.
                            title: Discarded Hits
                            type: integer
                            readOnly: true
                          hits:
                            description: The number of hits against the entity that occurred during the screening request.
                            title: Hits
                            type: integer
                            readOnly: true
                          maxScore:
                            title: Maximum Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.score of all of the matchedProfile records.
                            readOnly: true
                          primaryName:
                            title: Primary Name
                            type: string
                            description: For the screened entity, the matchedProfile.primaryName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          matchedName:
                            title: Matched name
                            type: string
                            description: For the screened entity, the matchedProfile.matchedName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          maxProximityScore:
                            title: Maximum Proximity Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.proximityScore of all of the matchedProfile records.
                            readOnly: true
                          matchedProfile:
                            description: The outcome data that is received from the watchlist screening engine when a hit occurs. This data is utilized in the alert generation process.
                            items:
                              properties:
                                categories:
                                  description: The list of categories assigned to the profile that is returned from the watchlist provider.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Categories
                                  type: array
                                checksum:
                                  description: A hash of the entire watchlist profile. This enables you to verify the value against your alerts database to determine if it has changed.
                                  title: Checksum
                                  type: integer
                                coreChecksum:
                                  description: The checksum value that is associated with the subset of profile data that constitutes important information. This changes only when properties that are part of the screening logic are changed. This includes names, addresses, IDs, date of birth, sanctions, and status.
                                  title: Core Checksum
                                  type: integer
                                dateOfBirth:
                                  description: The data provided about dates of birth.
                                  items:
                                    properties:
                                      birthDay:
                                        description: The day of birth.
                                        title: Day of Birth
                                        type: integer
                                      birthDt:
                                        description: The date of birth in ISO-8601 YYYY-MM-DD format.
                                        maxLength: 10
                                        readOnly: true
                                        title: Date of Birth
                                        type: string
                                      birthMonth:
                                        description: The month of birth.
                                        title: Month of Birth
                                        type: integer
                                      birthYear:
                                        description: The year of birth.
                                        title: Year of Birth
                                        type: integer
                                    type: object
                                  maxItems: 100
                                  title: Date of Birth
                                  type: array
                                geoScore:
                                  title: Geo Score
                                  description: A value that indicates the geographic degree of correspondence between the screened entity and the matched profile. A value of 0 indicates that no evidence was found. A value above 50 indicates that at least one country reference was found. Additional references further increase the score.
                                  type: integer
                                  readOnly: true
                                geoClues:
                                  title: Geo Clues
                                  description: A list of geographic references to the countries in the matched profiles.
                                  type: array
                                  items:
                                    maxLength: 200
                                    minLength: 1
                                    type: string
                                  maxItems: 100
                                  readOnly: true
                                exceptionId:
                                  description: The ID that is returned against an exception that is found and applied to a match. This internal ID is returned by the watchlist screening engine.
                                  maxLength: 50
                                  readOnly: true
                                  title: Exception ID
                                  type: string
                                exceptionReference:
                                  title: Exception Reference
                                  description: The reference ID that is associated with the exception. This is an internal identifier that is assigned when the exception is created.
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationPath:
                                  title: Location Path
                                  description: In a complex screened object (text or transaction), an indication as to where a match was found. For entity screening, the value is always '/'. For payment screening, the value is a screened field (such as '/debtor/name').
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationFrom:
                                  title: Location From
                                  description: In screened text, the 0-based start position where the match was found.
                                  type: integer
                                  readOnly: true
                                locationTo:
                                  title: Location To
                                  description: In screened text, the 0-based end position where the match was found.
                                  type: integer
                                  readOnly: true
                                mediaAgeScore:
                                  title: Media Age Score
                                  description: A score that indicates the age of the adverse media articles that are found in a profile.
                                  type: integer
                                  readOnly: true
                                mediaQuantityScore:
                                  title: Media Quantity Score
                                  description: A score that indicates the number of adverse media articles that were found in a watchlist profile as compared to the average number of adverse media reports for all profiles.
                                  type: integer
                                  readOnly: true
                                level:
                                  description: The strength of the hit. This is based on the elements that have matched (such as name, city, country, gender, DOB, ID). If a match occurs only on name, the level is always "low". Otherwise, the level corresponds to the highest level assigned to the matched criteria as defined in the metadata policies. If the match was ignored as a result of a screening exception, the level value is set to "discarded".
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Level
                                  type: string
                                links:
                                  description: The links to the watchlist profile resource and, if applicable, the screening exception resource that are related to the matched profile.
                                  items:
                                    properties:
                                      href:
                                        description: The URL for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: HREF
                                        type: string
                                      itemType:
                                        description: If this is a link to a container, itemType is the media type or link type for the items in the container.
                                        maxLength: 200
                                        readOnly: true
                                        title: Item Type
                                        type: string
                                      method:
                                        description: The HTTP method for the link.
                                        maxLength: 6
                                        minLength: 1
                                        readOnly: true
                                        title: Method
                                        type: string
                                      rel:
                                        description: The relationship of the link to the resource.
                                        maxLength: 50
                                        minLength: 1
                                        readOnly: true
                                        title: Relation Type
                                        type: string
                                      responseItemType:
                                        description: The media type or link type of the items in the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Item Type
                                        type: string
                                      responseType:
                                        description: The media type or link type of the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Type
                                        type: string
                                      title:
                                        description: The title for the link.
                                        maxLength: 100
                                        readOnly: true
                                        title: Title
                                        type: string
                                      type:
                                        description: The media type or link type for the link.
                                        maxLength: 200
                                        readOnly: true
                                        title: Media Type
                                        type: string
                                      uri:
                                        description: The relative URI for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: URI
                                        type: string
                                    type: object
                                  maxItems: 2
                                  required:
                                    - rel
                                  title: Links
                                  type: array
                                matchType:
                                  description: Provides an indication as to the basis of the type of matched data (name, ID, address, currency, country, web, etc.).
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Match Type
                                  type: string
                                matchedName:
                                  description: The name that matches the profile's primary name or one of its aliases.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Matched Name
                                  type: string
                                primaryName:
                                  description: The primary name of the matched profile.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Primary Name
                                  type: string
                                profileBirthPlaces:
                                  description: The data provided about birth places such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity was born.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity was born (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Birth Places
                                  type: array
                                profileGender:
                                  description: The gender of the matched profile, if known. Applies only for individuals.
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Gender
                                  type: string
                                profileId:
                                  description: The ID that is returned from the watchlist provider.
                                  maxLength: 100
                                  minLength: 1
                                  readOnly: true
                                  title: Profile ID
                                  type: string
                                profileIds:
                                  description: The list of all the IDs found in the profile that can potentially be matched with the IDs sent in the screened metadata.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile IDs
                                  type: array
                                profileLastUpdated:
                                  description: The timestamp of the profile's last update, in date-time format (RFC 3339).
                                  maxLength: 24
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Last Updated
                                  type: string
                                profilePlaces:
                                  description: The data provided about the location of the matched entity such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity is located.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity is located (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Places
                                  type: array
                                profileRelatedCountries:
                                  description: Other related countries of the matched profile (citizenships, incorporation, etc.).
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile Related Countries
                                  type: array
                                profileStatus:
                                  description: The status of the matched watchlist profile. The values indicate whether the record is active, inactive, deceased, or unknown.
                                  maxLength: 3
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Status
                                  type: string
                                profileType:
                                  description: The type of profile matched such as "individual", "entity", or "vessel".
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Type
                                  type: string
                                proximityScore:
                                  description: >-
                                    The proximity score with respect to a profile that is published by a watchlist.


                                    This attribute indicates how close a watchlist entry is to a sanctioned watchlist profile. Possible values include:


                                    100 - sanctioned profile


                                    80 - direct relationship with sanctioned profile


                                    50 - one relationship removed from a sanctioned profile


                                    0 - no relationship found


                                    null - undefined


                                    Note that all private list matches are returned as null (undefined).
                                  title: Proximity Score
                                  type: integer
                                  nullable: true
                                sanctions:
                                  description: The unique code of all the sanction lists in which this profile appears. These codes can be used in the "sanctions" preset field.
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Sanctions
                                  type: array
                                score:
                                  description: Indicates the confidence level of the match.
                                  title: Score
                                  type: integer
                                scoreScope:
                                  description: The list of matched metadata attributes such as DOB, city, country, gender, and ID.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Score Scope
                                  type: array
                                screened:
                                  description: >
                                    The text in the request in which the match was found. When screening names, this should be the same as the input string.

                                    When screening texts, this is a snippet containing the matched name.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Screened
                                  type: string
                                tags:
                                  description: >-
                                    Tags are used to indicate the type of list in which the record resides. It can also be used to indicate the entity type for the record.


                                    **List Types**:


                                    SAN = Sanctions Lists


                                    SIE = Special Interest Entity


                                    SIP = Special Interest Person


                                    PEP = Politically Exposed Person


                                    RCA = Relative or Close Associate


                                    SOC = State Owned Company


                                    OOL = Other Official Lists


                                    AM = Adverse Media


                                    BRD = Board Member


                                    **Entity Types**:


                                    LOC = Risk country


                                    VSL = Vessels


                                    AIR = Aircrafts


                                    For **Dow Jones Factiva**, see Description 1, Description 2, and Description 3.


                                    For **Refinitiv World-Check**, see Category and Sub-category.
                                  items:
                                    maxLength: 4
                                    minLength: 1
                                    type: string
                                  maxItems: 20
                                  title: Tags
                                  type: array
                              type: object
                            maxItems: 1000
                            title: Matched Profile
                            type: array
                            readOnly: true
                          messageReference:
                            description: The unique identifier that is generated by SAS Real-Time Watchlist Screening for a screening request. This value is populated in the screening response and is ignored on input.
                            maxLength: 36
                            minLength: 0
                            readOnly: true
                            title: Message Reference
                            type: string
                          statusCode:
                            description: >-
                              The status of a screening request at the record level.
                               •  Success = screening successful
                               •  Warning = screening successful with warnings
                               •  Validation Failure = screening request failure
                               •  Failure = screening response failure
                            maxLength: 18
                            minLength: 7
                            readOnly: true
                            title: Status Code
                            type: string
                        readOnly: true
                        title: Screening Result
                        type: object
                      surname:
                        description: The surname of the entity being screened. If used with firstName, the two fields are combined to form the full name of the entity. The value must be at least 2 characters and not more than 100 characters.
                        maxLength: 100
                        minLength: 2
                        title: Surname
                        type: string
                      text:
                        description: The party information as unstructured data.  If the name field is specified, this field is ignored.
                        maxLength: 1000
                        title: Text
                        type: string
                    title: Creditor Agent
                    type: object
                  currency:
                    description: The 3-digit ISO currency code, such as AUD, CHF, or USD.
                    maxLength: 3
                    minLength: 3
                    title: Currency
                    type: string
                  dataSource:
                    description: The data source of the message such as Swift, SEPA, or Core banking.
                    maxLength: 50
                    title: Data Source
                    type: string
                  debtor:
                    description: Debtor information.
                    properties:
                      account:
                        description: Incoming data from the customers that contain information that is related to a transaction.
                        properties:
                          currency:
                            description: The 3-digit alphabetic ISO currency code that is associated with the account.
                            maxLength: 3
                            minLength: 3
                            title: Currency
                            type: string
                          name:
                            description: The name of the account, as assigned by the account servicing institution. This provides an additional means of identification for the account.
                            maxLength: 200
                            title: Name
                            type: string
                          number:
                            description: The unique identifier that is associated with the account. This field is required and must be between 1 and 100 characters in length.
                            maxLength: 100
                            minLength: 1
                            title: Account Number
                            type: string
                          proxy:
                            description: An alternate assumed name for the identification of the account.
                            maxLength: 200
                            title: Proxy
                            type: string
                          type:
                            description: The type of the account (for example, savings, checking, and so on).
                            maxLength: 200
                            title: Account Type
                            type: string
                        required:
                          - number
                        title: Account
                        type: object
                      dateOfBirth:
                        description: >-
                          A supplied birthdate for the entity being screened. This object is used only when the type of entity being screened is "individual".

                          * If the birthtDt field is supplied, the birthDay, birthMonth, and birthYear fields are not used in the screening request.

                          * If the birthDt field is not supplied, an attempt is made to interpret the birthDay, birthMonth, and birthYear as a date, and use that in the screening request.

                          * If the birthDay or birthMonth are not specified, only the birthYear is used in the screening request.
                        properties:
                          birthDay:
                            description: The numeric birth day of the month for the entity being screened. This field can be used in combination with birthMonth and birthYear.
                            title: Day of Birth
                            type: integer
                          birthDt:
                            description: The birthdate, in ISO-8601 YYYY-MM-DD format, of the entity being screened. If provided, this field must be valid for the screening request to succeed.
                            maxLength: 10
                            title: Date of Birth
                            type: string
                          birthMonth:
                            description: The numeric birth month for the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthYear.
                            title: Month of Birth
                            type: integer
                          birthYear:
                            description: The birth year of the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthMonth.
                            title: Year of Birth
                            type: integer
                        title: Date of Birth
                        type: object
                      firstName:
                        description: The first name or names of the party.
                        maxLength: 100
                        minLength: 2
                        title: First Name
                        type: string
                      gender:
                        description: For an individual party, the gender of the person.  If not specified or an unexpected value is supplied, the record is processed using "other". Valid values are "male", "female", and "other".
                        maxLength: 10
                        title: Gender
                        type: string
                      identity:
                        description: The attributes that correspond to an entity's proof of identity.
                        items:
                          properties:
                            countryOfIssue:
                              description: The numeric ISO code of the country that is associated with the supplied form of identification for the entity.
                              title: Country of Issue (ISO)
                              type: integer
                            countryOfIssueCode:
                              description: The ISO 3166 alphabetic code of the country that is associated with the supplied form of identification for the entity. This can be an Alpha-2 or Alpha-3 code.
                              maxLength: 3
                              title: Country of Issue Code
                              type: string
                            dateOfExpiry:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Expiry
                              type: string
                            dateOfIssue:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Issue
                              type: string
                            details:
                              description: Additional details for this form of identification.
                              maxLength: 100
                              title: Identity Details
                              type: string
                            issuedBy:
                              description: The entity that issued the identification.
                              maxLength: 36
                              title: Issued By
                              type: string
                            number:
                              description: The identifying number that is associated with the supplied form of identification for the entity. If a form of identity is provided, this field is required and must be valid for the screening request to succeed.
                              maxLength: 100
                              minLength: 1
                              title: Identity Number
                              type: string
                            type:
                              description: The type of identification that is supplied.
                              maxLength: 36
                              title: Identity Type
                              type: string
                            validFrom:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid From
                              type: string
                            validTo:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid To
                              type: string
                          required:
                            - number
                          type: object
                        maxItems: 100
                        title: Identity
                        type: array
                      label:
                        description: An optional label that is used to help identify the party's role or map the party's role to the original transaction object.
                        maxLength: 200
                        title: Label
                        type: string
                      name:
                        description: >
                          The name of the entity being screened. If this field is specified,

                          the surname and firstName fields are ignored. The value must be at least 2 characters and not more than 220 characters. For individuals, the

                          value is interpreted as a comma-delimited list of "surname, first name".
                        maxLength: 220
                        minLength: 2
                        title: Name
                        type: string
                      placeOfBirth:
                        description: Incoming data from the customers that contain information related to the place of birth of a party that is involved in a transaction.
                        properties:
                          addressLines:
                            description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                            items:
                              maxLength: 500
                              type: string
                            title: Address Lines
                            type: array
                          city:
                            description: The city in which the party was born.
                            maxLength: 100
                            title: City
                            type: string
                          countryCode:
                            description: The alphabetic ISO 3166 code of the country in which the party was born. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                            maxLength: 3
                            minLength: 2
                            title: Country Code
                            type: string
                          postCode:
                            description: The postcode or ZIP code in which the party was born.
                            maxLength: 36
                            title: Post Code
                            type: string
                          state:
                            description: An optional code or name of the state in which the party was born.
                            maxLength: 100
                            title: State
                            type: string
                          text:
                            description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                            maxLength: 500
                            title: Text
                            type: string
                        required:
                          - countryCode
                        title: Place of Birth
                        type: object
                      postalAddress:
                        description: Incoming data from the customers that contain information related to the postal address of a party that is involved in a transaction.
                        items:
                          properties:
                            addressLines:
                              description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                              items:
                                maxLength: 500
                                type: string
                              title: Address Lines
                              type: array
                            city:
                              description: The city in which the party is located.
                              maxLength: 100
                              title: City
                              type: string
                            countryCode:
                              description: The alphabetic ISO 3166 code of the country in which the party is located. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                              maxLength: 3
                              minLength: 2
                              title: Country Code
                              type: string
                            postCode:
                              description: The postcode or ZIP code in which the party is located.
                              maxLength: 36
                              title: Address Postcode
                              type: string
                            state:
                              description: An optional code or name of the state in which the party is located.
                              maxLength: 100
                              title: State
                              type: string
                            text:
                              description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                              maxLength: 500
                              title: Text
                              type: string
                          type: object
                        maxItems: 100
                        required:
                          - countryCode
                        title: Postal Address
                        type: array
                      screeningResult:
                        description: The result of a screening.
                        properties:
                          discardedHits:
                            description: The number of discarded hits against the entity that occurred during the screening request as a result of a screening exception.
                            title: Discarded Hits
                            type: integer
                            readOnly: true
                          hits:
                            description: The number of hits against the entity that occurred during the screening request.
                            title: Hits
                            type: integer
                            readOnly: true
                          maxScore:
                            title: Maximum Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.score of all of the matchedProfile records.
                            readOnly: true
                          primaryName:
                            title: Primary Name
                            type: string
                            description: For the screened entity, the matchedProfile.primaryName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          matchedName:
                            title: Matched name
                            type: string
                            description: For the screened entity, the matchedProfile.matchedName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          maxProximityScore:
                            title: Maximum Proximity Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.proximityScore of all of the matchedProfile records.
                            readOnly: true
                          matchedProfile:
                            description: The outcome data that is received from the watchlist screening engine when a hit occurs. This data is utilized in the alert generation process.
                            items:
                              properties:
                                categories:
                                  description: The list of categories assigned to the profile that is returned from the watchlist provider.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Categories
                                  type: array
                                checksum:
                                  description: A hash of the entire watchlist profile. This enables you to verify the value against your alerts database to determine if it has changed.
                                  title: Checksum
                                  type: integer
                                coreChecksum:
                                  description: The checksum value that is associated with the subset of profile data that constitutes important information. This changes only when properties that are part of the screening logic are changed. This includes names, addresses, IDs, date of birth, sanctions, and status.
                                  title: Core Checksum
                                  type: integer
                                dateOfBirth:
                                  description: The data provided about dates of birth.
                                  items:
                                    properties:
                                      birthDay:
                                        description: The day of birth.
                                        title: Day of Birth
                                        type: integer
                                      birthDt:
                                        description: The date of birth in ISO-8601 YYYY-MM-DD format.
                                        maxLength: 10
                                        readOnly: true
                                        title: Date of Birth
                                        type: string
                                      birthMonth:
                                        description: The month of birth.
                                        title: Month of Birth
                                        type: integer
                                      birthYear:
                                        description: The year of birth.
                                        title: Year of Birth
                                        type: integer
                                    type: object
                                  maxItems: 100
                                  title: Date of Birth
                                  type: array
                                geoScore:
                                  title: Geo Score
                                  description: A value that indicates the geographic degree of correspondence between the screened entity and the matched profile. A value of 0 indicates that no evidence was found. A value above 50 indicates that at least one country reference was found. Additional references further increase the score.
                                  type: integer
                                  readOnly: true
                                geoClues:
                                  title: Geo Clues
                                  description: A list of geographic references to the countries in the matched profiles.
                                  type: array
                                  items:
                                    maxLength: 200
                                    minLength: 1
                                    type: string
                                  maxItems: 100
                                  readOnly: true
                                exceptionId:
                                  description: The ID that is returned against an exception that is found and applied to a match. This internal ID is returned by the watchlist screening engine.
                                  maxLength: 50
                                  readOnly: true
                                  title: Exception ID
                                  type: string
                                exceptionReference:
                                  title: Exception Reference
                                  description: The reference ID that is associated with the exception. This is an internal identifier that is assigned when the exception is created.
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationPath:
                                  title: Location Path
                                  description: In a complex screened object (text or transaction), an indication as to where a match was found. For entity screening, the value is always '/'. For payment screening, the value is a screened field (such as '/debtor/name').
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationFrom:
                                  title: Location From
                                  description: In screened text, the 0-based start position where the match was found.
                                  type: integer
                                  readOnly: true
                                locationTo:
                                  title: Location To
                                  description: In screened text, the 0-based end position where the match was found.
                                  type: integer
                                  readOnly: true
                                mediaAgeScore:
                                  title: Media Age Score
                                  description: A score that indicates the age of the adverse media articles that are found in a profile.
                                  type: integer
                                  readOnly: true
                                mediaQuantityScore:
                                  title: Media Quantity Score
                                  description: A score that indicates the number of adverse media articles that were found in a watchlist profile as compared to the average number of adverse media reports for all profiles.
                                  type: integer
                                  readOnly: true
                                level:
                                  description: The strength of the hit. This is based on the elements that have matched (such as name, city, country, gender, DOB, ID). If a match occurs only on name, the level is always "low". Otherwise, the level corresponds to the highest level assigned to the matched criteria as defined in the metadata policies. If the match was ignored as a result of a screening exception, the level value is set to "discarded".
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Level
                                  type: string
                                links:
                                  description: The links to the watchlist profile resource and, if applicable, the screening exception resource that are related to the matched profile.
                                  items:
                                    properties:
                                      href:
                                        description: The URL for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: HREF
                                        type: string
                                      itemType:
                                        description: If this is a link to a container, itemType is the media type or link type for the items in the container.
                                        maxLength: 200
                                        readOnly: true
                                        title: Item Type
                                        type: string
                                      method:
                                        description: The HTTP method for the link.
                                        maxLength: 6
                                        minLength: 1
                                        readOnly: true
                                        title: Method
                                        type: string
                                      rel:
                                        description: The relationship of the link to the resource.
                                        maxLength: 50
                                        minLength: 1
                                        readOnly: true
                                        title: Relation Type
                                        type: string
                                      responseItemType:
                                        description: The media type or link type of the items in the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Item Type
                                        type: string
                                      responseType:
                                        description: The media type or link type of the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Type
                                        type: string
                                      title:
                                        description: The title for the link.
                                        maxLength: 100
                                        readOnly: true
                                        title: Title
                                        type: string
                                      type:
                                        description: The media type or link type for the link.
                                        maxLength: 200
                                        readOnly: true
                                        title: Media Type
                                        type: string
                                      uri:
                                        description: The relative URI for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: URI
                                        type: string
                                    type: object
                                  maxItems: 2
                                  required:
                                    - rel
                                  title: Links
                                  type: array
                                matchType:
                                  description: Provides an indication as to the basis of the type of matched data (name, ID, address, currency, country, web, etc.).
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Match Type
                                  type: string
                                matchedName:
                                  description: The name that matches the profile's primary name or one of its aliases.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Matched Name
                                  type: string
                                primaryName:
                                  description: The primary name of the matched profile.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Primary Name
                                  type: string
                                profileBirthPlaces:
                                  description: The data provided about birth places such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity was born.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity was born (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Birth Places
                                  type: array
                                profileGender:
                                  description: The gender of the matched profile, if known. Applies only for individuals.
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Gender
                                  type: string
                                profileId:
                                  description: The ID that is returned from the watchlist provider.
                                  maxLength: 100
                                  minLength: 1
                                  readOnly: true
                                  title: Profile ID
                                  type: string
                                profileIds:
                                  description: The list of all the IDs found in the profile that can potentially be matched with the IDs sent in the screened metadata.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile IDs
                                  type: array
                                profileLastUpdated:
                                  description: The timestamp of the profile's last update, in date-time format (RFC 3339).
                                  maxLength: 24
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Last Updated
                                  type: string
                                profilePlaces:
                                  description: The data provided about the location of the matched entity such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity is located.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity is located (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Places
                                  type: array
                                profileRelatedCountries:
                                  description: Other related countries of the matched profile (citizenships, incorporation, etc.).
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile Related Countries
                                  type: array
                                profileStatus:
                                  description: The status of the matched watchlist profile. The values indicate whether the record is active, inactive, deceased, or unknown.
                                  maxLength: 3
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Status
                                  type: string
                                profileType:
                                  description: The type of profile matched such as "individual", "entity", or "vessel".
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Type
                                  type: string
                                proximityScore:
                                  description: >-
                                    The proximity score with respect to a profile that is published by a watchlist.


                                    This attribute indicates how close a watchlist entry is to a sanctioned watchlist profile. Possible values include:


                                    100 - sanctioned profile


                                    80 - direct relationship with sanctioned profile


                                    50 - one relationship removed from a sanctioned profile


                                    0 - no relationship found


                                    null - undefined


                                    Note that all private list matches are returned as null (undefined).
                                  title: Proximity Score
                                  type: integer
                                  nullable: true
                                sanctions:
                                  description: The unique code of all the sanction lists in which this profile appears. These codes can be used in the "sanctions" preset field.
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Sanctions
                                  type: array
                                score:
                                  description: Indicates the confidence level of the match.
                                  title: Score
                                  type: integer
                                scoreScope:
                                  description: The list of matched metadata attributes such as DOB, city, country, gender, and ID.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Score Scope
                                  type: array
                                screened:
                                  description: >
                                    The text in the request in which the match was found. When screening names, this should be the same as the input string.

                                    When screening texts, this is a snippet containing the matched name.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Screened
                                  type: string
                                tags:
                                  description: >-
                                    Tags are used to indicate the type of list in which the record resides. It can also be used to indicate the entity type for the record.


                                    **List Types**:


                                    SAN = Sanctions Lists


                                    SIE = Special Interest Entity


                                    SIP = Special Interest Person


                                    PEP = Politically Exposed Person


                                    RCA = Relative or Close Associate


                                    SOC = State Owned Company


                                    OOL = Other Official Lists


                                    AM = Adverse Media


                                    BRD = Board Member


                                    **Entity Types**:


                                    LOC = Risk country


                                    VSL = Vessels


                                    AIR = Aircrafts


                                    For **Dow Jones Factiva**, see Description 1, Description 2, and Description 3.


                                    For **Refinitiv World-Check**, see Category and Sub-category.
                                  items:
                                    maxLength: 4
                                    minLength: 1
                                    type: string
                                  maxItems: 20
                                  title: Tags
                                  type: array
                              type: object
                            maxItems: 1000
                            title: Matched Profile
                            type: array
                            readOnly: true
                          messageReference:
                            description: The unique identifier that is generated by SAS Real-Time Watchlist Screening for a screening request. This value is populated in the screening response and is ignored on input.
                            maxLength: 36
                            minLength: 0
                            readOnly: true
                            title: Message Reference
                            type: string
                          statusCode:
                            description: >-
                              The status of a screening request at the record level.
                               •  Success = screening successful
                               •  Warning = screening successful with warnings
                               •  Validation Failure = screening request failure
                               •  Failure = screening response failure
                            maxLength: 18
                            minLength: 7
                            readOnly: true
                            title: Status Code
                            type: string
                        readOnly: true
                        title: Screening Result
                        type: object
                      surname:
                        description: The surname of the entity being screened. If used with firstName, the two fields are combined to form the full name of the entity. The value must be at least 2 characters and not more than 100 characters.
                        maxLength: 100
                        minLength: 2
                        title: Surname
                        type: string
                      text:
                        description: The party information as unstructured data.  If the name field is specified, this field is ignored.
                        maxLength: 1000
                        title: Text
                        type: string
                    title: Debtor
                    type: object
                  debtorAgent:
                    description: Debtor agent information.
                    properties:
                      account:
                        description: Incoming data from the customers that contain information that is related to a transaction.
                        properties:
                          currency:
                            description: The 3-digit alphabetic ISO currency code that is associated with the account.
                            maxLength: 3
                            minLength: 3
                            title: Currency
                            type: string
                          name:
                            description: The name of the account, as assigned by the account servicing institution. This provides an additional means of identification for the account.
                            maxLength: 200
                            title: Name
                            type: string
                          number:
                            description: The unique identifier that is associated with the account. This field is required and must be between 1 and 100 characters in length.
                            maxLength: 100
                            minLength: 1
                            title: Account Number
                            type: string
                          proxy:
                            description: An alternate assumed name for the identification of the account.
                            maxLength: 200
                            title: Proxy
                            type: string
                          type:
                            description: The type of the account (for example, savings, checking, and so on).
                            maxLength: 200
                            title: Account Type
                            type: string
                        required:
                          - number
                        title: Account
                        type: object
                      dateOfBirth:
                        description: >-
                          A supplied birthdate for the entity being screened. This object is used only when the type of entity being screened is "individual".

                          * If the birthtDt field is supplied, the birthDay, birthMonth, and birthYear fields are not used in the screening request.

                          * If the birthDt field is not supplied, an attempt is made to interpret the birthDay, birthMonth, and birthYear as a date, and use that in the screening request.

                          * If the birthDay or birthMonth are not specified, only the birthYear is used in the screening request.
                        properties:
                          birthDay:
                            description: The numeric birth day of the month for the entity being screened. This field can be used in combination with birthMonth and birthYear.
                            title: Day of Birth
                            type: integer
                          birthDt:
                            description: The birthdate, in ISO-8601 YYYY-MM-DD format, of the entity being screened. If provided, this field must be valid for the screening request to succeed.
                            maxLength: 10
                            title: Date of Birth
                            type: string
                          birthMonth:
                            description: The numeric birth month for the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthYear.
                            title: Month of Birth
                            type: integer
                          birthYear:
                            description: The birth year of the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthMonth.
                            title: Year of Birth
                            type: integer
                        title: Date of Birth
                        type: object
                      firstName:
                        description: The first name or names of the party.
                        maxLength: 100
                        minLength: 2
                        title: First Name
                        type: string
                      gender:
                        description: For an individual party, the gender of the person.  If not specified or an unexpected value is supplied, the record is processed using "other". Valid values are "male", "female", and "other".
                        maxLength: 10
                        title: Gender
                        type: string
                      identity:
                        description: The attributes that correspond to an entity's proof of identity.
                        items:
                          properties:
                            countryOfIssue:
                              description: The numeric ISO code of the country that is associated with the supplied form of identification for the entity.
                              title: Country of Issue (ISO)
                              type: integer
                            countryOfIssueCode:
                              description: The ISO 3166 alphabetic code of the country that is associated with the supplied form of identification for the entity. This can be an Alpha-2 or Alpha-3 code.
                              maxLength: 3
                              title: Country of Issue Code
                              type: string
                            dateOfExpiry:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Expiry
                              type: string
                            dateOfIssue:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Issue
                              type: string
                            details:
                              description: Additional details for this form of identification.
                              maxLength: 100
                              title: Identity Details
                              type: string
                            issuedBy:
                              description: The entity that issued the identification.
                              maxLength: 36
                              title: Issued By
                              type: string
                            number:
                              description: The identifying number that is associated with the supplied form of identification for the entity. If a form of identity is provided, this field is required and must be valid for the screening request to succeed.
                              maxLength: 100
                              minLength: 1
                              title: Identity Number
                              type: string
                            type:
                              description: The type of identification that is supplied.
                              maxLength: 36
                              title: Identity Type
                              type: string
                            validFrom:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid From
                              type: string
                            validTo:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid To
                              type: string
                          required:
                            - number
                          type: object
                        maxItems: 100
                        title: Identity
                        type: array
                      label:
                        description: An optional label that is used to help identify the party's role or map the party's role to the original transaction object.
                        maxLength: 200
                        title: Label
                        type: string
                      name:
                        description: >
                          The name of the entity being screened. If this field is specified,

                          the surname and firstName fields are ignored. The value must be at least 2 characters and not more than 220 characters. For individuals, the

                          value is interpreted as a comma-delimited list of "surname, first name".
                        maxLength: 220
                        minLength: 2
                        title: Name
                        type: string
                      placeOfBirth:
                        description: Incoming data from the customers that contain information related to the place of birth of a party that is involved in a transaction.
                        properties:
                          addressLines:
                            description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                            items:
                              maxLength: 500
                              type: string
                            title: Address Lines
                            type: array
                          city:
                            description: The city in which the party was born.
                            maxLength: 100
                            title: City
                            type: string
                          countryCode:
                            description: The alphabetic ISO 3166 code of the country in which the party was born. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                            maxLength: 3
                            minLength: 2
                            title: Country Code
                            type: string
                          postCode:
                            description: The postcode or ZIP code in which the party was born.
                            maxLength: 36
                            title: Address Postcode
                            type: string
                          state:
                            description: An optional code or name of the state in which the party was born.
                            maxLength: 100
                            title: State
                            type: string
                          text:
                            description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                            maxLength: 500
                            title: Text
                            type: string
                        required:
                          - countryCode
                        title: Place of Birth
                        type: object
                      postalAddress:
                        description: Incoming data from the customers that contain information related to the postal address of a party that is involved in a transaction.
                        items:
                          properties:
                            addressLines:
                              description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                              items:
                                maxLength: 500
                                type: string
                              title: Address Lines
                              type: array
                            city:
                              description: The city in which the party is located.
                              maxLength: 100
                              title: City
                              type: string
                            countryCode:
                              description: The alphabetic ISO 3166 code of the country in which the party is located. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                              maxLength: 3
                              minLength: 2
                              title: Country Code
                              type: string
                            postCode:
                              description: The postcode or ZIP code in which the party is located.
                              maxLength: 36
                              title: Address Postcode
                              type: string
                            state:
                              description: An optional code or name of the state in which the party is located.
                              maxLength: 100
                              title: State
                              type: string
                            text:
                              description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                              maxLength: 500
                              title: Text
                              type: string
                          type: object
                        maxItems: 100
                        required:
                          - countryCode
                        title: Postal Address
                        type: array
                      screeningResult:
                        description: The result of a screening.
                        properties:
                          discardedHits:
                            description: The number of discarded hits against the entity that occurred during the screening request as a result of a screening exception.
                            title: Discarded Hits
                            type: integer
                            readOnly: true
                          hits:
                            description: The number of hits against the entity that occurred during the screening request.
                            title: Hits
                            type: integer
                            readOnly: true
                          maxScore:
                            title: Maximum Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.score of all of the matchedProfile records.
                            readOnly: true
                          primaryName:
                            title: Primary Name
                            type: string
                            description: For the screened entity, the matchedProfile.primaryName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          matchedName:
                            title: Matched name
                            type: string
                            description: For the screened entity, the matchedProfile.matchedName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          maxProximityScore:
                            title: Maximum Proximity Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.proximityScore of all of the matchedProfile records.
                            readOnly: true
                          matchedProfile:
                            description: The outcome data that is received from the watchlist screening engine when a hit occurs. This data is utilized in the alert generation process.
                            items:
                              properties:
                                categories:
                                  description: The list of categories assigned to the profile that is returned from the watchlist provider.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Categories
                                  type: array
                                checksum:
                                  description: A hash of the entire watchlist profile. This enables you to verify the value against your alerts database to determine if it has changed.
                                  title: Checksum
                                  type: integer
                                coreChecksum:
                                  description: The checksum value that is associated with the subset of profile data that constitutes important information. This changes only when properties that are part of the screening logic are changed. This includes names, addresses, IDs, date of birth, sanctions, and status.
                                  title: Core Checksum
                                  type: integer
                                dateOfBirth:
                                  description: The data provided about dates of birth.
                                  items:
                                    properties:
                                      birthDay:
                                        description: The day of birth.
                                        title: Day of Birth
                                        type: integer
                                      birthDt:
                                        description: The date of birth in ISO-8601 YYYY-MM-DD format.
                                        maxLength: 10
                                        readOnly: true
                                        title: Date of Birth
                                        type: string
                                      birthMonth:
                                        description: The month of birth.
                                        title: Month of Birth
                                        type: integer
                                      birthYear:
                                        description: The year of birth.
                                        title: Year of Birth
                                        type: integer
                                    type: object
                                  maxItems: 100
                                  title: Date of Birth
                                  type: array
                                geoScore:
                                  title: Geo Score
                                  description: A value that indicates the geographic degree of correspondence between the screened entity and the matched profile. A value of 0 indicates that no evidence was found. A value above 50 indicates that at least one country reference was found. Additional references further increase the score.
                                  type: integer
                                  readOnly: true
                                geoClues:
                                  title: Geo Clues
                                  description: A list of geographic references to the countries in the matched profiles.
                                  type: array
                                  items:
                                    maxLength: 200
                                    minLength: 1
                                    type: string
                                  maxItems: 100
                                  readOnly: true
                                exceptionId:
                                  description: The ID that is returned against an exception that is found and applied to a match. This internal ID is returned by the watchlist screening engine.
                                  maxLength: 50
                                  readOnly: true
                                  title: Exception ID
                                  type: string
                                exceptionReference:
                                  title: Exception Reference
                                  description: The reference ID that is associated with the exception. This is an internal identifier that is assigned when the exception is created.
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationPath:
                                  title: Location Path
                                  description: In a complex screened object (text or transaction), an indication as to where a match was found. For entity screening, the value is always '/'. For payment screening, the value is a screened field (such as '/debtor/name').
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationFrom:
                                  title: Location From
                                  description: In screened text, the 0-based start position where the match was found.
                                  type: integer
                                  readOnly: true
                                locationTo:
                                  title: Location To
                                  description: In screened text, the 0-based end position where the match was found.
                                  type: integer
                                  readOnly: true
                                mediaAgeScore:
                                  title: Media Age Score
                                  description: A score that indicates the age of the adverse media articles that are found in a profile.
                                  type: integer
                                  readOnly: true
                                mediaQuantityScore:
                                  title: Media Quantity Score
                                  description: A score that indicates the number of adverse media articles that were found in a watchlist profile as compared to the average number of adverse media reports for all profiles.
                                  type: integer
                                  readOnly: true
                                level:
                                  description: The strength of the hit. This is based on the elements that have matched (such as name, city, country, gender, DOB, ID). If a match occurs only on name, the level is always "low". Otherwise, the level corresponds to the highest level assigned to the matched criteria as defined in the metadata policies. If the match was ignored as a result of a screening exception, the level value is set to "discarded".
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Level
                                  type: string
                                links:
                                  description: The links to the watchlist profile resource and, if applicable, the screening exception resource that are related to the matched profile.
                                  items:
                                    properties:
                                      href:
                                        description: The URL for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: HREF
                                        type: string
                                      itemType:
                                        description: If this is a link to a container, itemType is the media type or link type for the items in the container.
                                        maxLength: 200
                                        readOnly: true
                                        title: Item Type
                                        type: string
                                      method:
                                        description: The HTTP method for the link.
                                        maxLength: 6
                                        minLength: 1
                                        readOnly: true
                                        title: Method
                                        type: string
                                      rel:
                                        description: The relationship of the link to the resource.
                                        maxLength: 50
                                        minLength: 1
                                        readOnly: true
                                        title: Relation Type
                                        type: string
                                      responseItemType:
                                        description: The media type or link type of the items in the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Item Type
                                        type: string
                                      responseType:
                                        description: The media type or link type of the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Type
                                        type: string
                                      title:
                                        description: The title for the link.
                                        maxLength: 100
                                        readOnly: true
                                        title: Title
                                        type: string
                                      type:
                                        description: The media type or link type for the link.
                                        maxLength: 200
                                        readOnly: true
                                        title: Media Type
                                        type: string
                                      uri:
                                        description: The relative URI for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: URI
                                        type: string
                                    type: object
                                  maxItems: 2
                                  required:
                                    - rel
                                  title: Links
                                  type: array
                                matchType:
                                  description: Provides an indication as to the basis of the type of matched data (name, ID, address, currency, country, web, etc.).
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Match Type
                                  type: string
                                matchedName:
                                  description: The name that matches the profile's primary name or one of its aliases.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Matched Name
                                  type: string
                                primaryName:
                                  description: The primary name of the matched profile.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Primary Name
                                  type: string
                                profileBirthPlaces:
                                  description: The data provided about birth places such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity was born.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity was born (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Birth Places
                                  type: array
                                profileGender:
                                  description: The gender of the matched profile, if known. Applies only for individuals.
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Gender
                                  type: string
                                profileId:
                                  description: The ID that is returned from the watchlist provider.
                                  maxLength: 100
                                  minLength: 1
                                  readOnly: true
                                  title: Profile ID
                                  type: string
                                profileIds:
                                  description: The list of all the IDs found in the profile that can potentially be matched with the IDs sent in the screened metadata.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile IDs
                                  type: array
                                profileLastUpdated:
                                  description: The timestamp of the profile's last update, in date-time format (RFC 3339).
                                  maxLength: 24
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Last Updated
                                  type: string
                                profilePlaces:
                                  description: The data provided about the location of the matched entity such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity is located.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity is located (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Places
                                  type: array
                                profileRelatedCountries:
                                  description: Other related countries of the matched profile (citizenships, incorporation, etc.).
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile Related Countries
                                  type: array
                                profileStatus:
                                  description: The status of the matched watchlist profile. The values indicate whether the record is active, inactive, deceased, or unknown.
                                  maxLength: 3
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Status
                                  type: string
                                profileType:
                                  description: The type of profile matched such as "individual", "entity", or "vessel".
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Type
                                  type: string
                                proximityScore:
                                  description: >-
                                    The proximity score with respect to a profile that is published by a watchlist.


                                    This attribute indicates how close a watchlist entry is to a sanctioned watchlist profile. Possible values include:


                                    100 - sanctioned profile


                                    80 - direct relationship with sanctioned profile


                                    50 - one relationship removed from a sanctioned profile


                                    0 - no relationship found


                                    null - undefined


                                    Note that all private list matches are returned as null (undefined).
                                  title: Proximity Score
                                  type: integer
                                  nullable: true
                                sanctions:
                                  description: The unique code of all the sanction lists in which this profile appears. These codes can be used in the "sanctions" preset field.
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Sanctions
                                  type: array
                                score:
                                  description: Indicates the confidence level of the match.
                                  title: Score
                                  type: integer
                                scoreScope:
                                  description: The list of matched metadata attributes such as DOB, city, country, gender, and ID.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Score Scope
                                  type: array
                                screened:
                                  description: >
                                    The text in the request in which the match was found. When screening names, this should be the same as the input string.

                                    When screening texts, this is a snippet containing the matched name.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Screened
                                  type: string
                                tags:
                                  description: >-
                                    Tags are used to indicate the type of list in which the record resides. It can also be used to indicate the entity type for the record.


                                    **List Types**:


                                    SAN = Sanctions Lists


                                    SIE = Special Interest Entity


                                    SIP = Special Interest Person


                                    PEP = Politically Exposed Person


                                    RCA = Relative or Close Associate


                                    SOC = State Owned Company


                                    OOL = Other Official Lists


                                    AM = Adverse Media


                                    BRD = Board Member


                                    **Entity Types**:


                                    LOC = Risk country


                                    VSL = Vessels


                                    AIR = Aircrafts


                                    For **Dow Jones Factiva**, see Description 1, Description 2, and Description 3.


                                    For **Refinitiv World-Check**, see Category and Sub-category.
                                  items:
                                    maxLength: 4
                                    minLength: 1
                                    type: string
                                  maxItems: 20
                                  title: Tags
                                  type: array
                              type: object
                            maxItems: 1000
                            title: Matched Profile
                            type: array
                            readOnly: true
                          messageReference:
                            description: The unique identifier that is generated by SAS Real-Time Watchlist Screening for a screening request. This value is populated in the screening response and is ignored on input.
                            maxLength: 36
                            minLength: 0
                            readOnly: true
                            title: Message Reference
                            type: string
                          statusCode:
                            description: >-
                              The status of a screening request at the record level.
                               •  Success = screening successful
                               •  Warning = screening successful with warnings
                               •  Validation Failure = screening request failure
                               •  Failure = screening response failure
                            maxLength: 18
                            minLength: 7
                            readOnly: true
                            title: Status Code
                            type: string
                        readOnly: true
                        title: Screening Result
                        type: object
                      surname:
                        description: The surname of the entity being screened. If used with firstName, the two fields are combined to form the full name of the entity. The value must be at least 2 characters and not more than 100 characters.
                        maxLength: 100
                        minLength: 2
                        title: Surname
                        type: string
                      text:
                        description: The party information as unstructured data.  If the name field is specified, this field is ignored.
                        maxLength: 1000
                        title: Text
                        type: string
                    title: Debtor Agent
                    type: object
                  direction:
                    description: >-
                      The direction indicator for the payment. Valid values are as follows:
                       * input
                       * output
                    maxLength: 10
                    title: Direction
                    type: string
                  exclusions:
                    description: >-
                      The party property types to be excluded from the payment screening process. Valid values are as follows:
                       * initiatingParty
                       * debtor
                       * debtorAgent
                       * ultimateDebtor
                       * creditor
                       * creditorAgent
                       * ultimateCreditor
                       * intermediaries
                    items:
                      maxLength: 100
                      type: string
                    maxItems: 10
                    title: Exclusions
                    type: array
                  identifier:
                    description: The unique identifier for the payment. This field is required and must be between 5 and 100 characters in length.
                    maxLength: 100
                    minLength: 5
                    title: Identifier
                    type: string
                  initiatingParty:
                    description: Initiating party information.
                    properties:
                      account:
                        description: Incoming data from the customers that contain information that is related to a transaction.
                        properties:
                          currency:
                            description: The 3-digit alphabetic ISO currency code that is associated with the account.
                            maxLength: 3
                            minLength: 3
                            title: Currency
                            type: string
                          name:
                            description: The name of the account, as assigned by the account servicing institution. This provides an additional means of identification for the account.
                            maxLength: 200
                            title: Name
                            type: string
                          number:
                            description: The unique identifier that is associated with the account. This field is required and must be between 1 and 100 characters in length.
                            maxLength: 100
                            minLength: 1
                            title: Account Number
                            type: string
                          proxy:
                            description: An alternate assumed name for the identification of the account.
                            maxLength: 200
                            title: Proxy
                            type: string
                          type:
                            description: The type of the account (for example, savings, checking, and so on).
                            maxLength: 200
                            title: Account Type
                            type: string
                        required:
                          - number
                        title: Account
                        type: object
                      dateOfBirth:
                        description: >-
                          A supplied birthdate for the entity being screened. This object is used only when the type of entity being screened is "individual".

                          * If the birthtDt field is supplied, the birthDay, birthMonth, and birthYear fields are not used in the screening request.

                          * If the birthDt field is not supplied, an attempt is made to interpret the birthDay, birthMonth, and birthYear as a date, and use that in the screening request.

                          * If the birthDay or birthMonth are not specified, only the birthYear is used in the screening request.
                        properties:
                          birthDay:
                            description: The numeric birth day of the month for the entity being screened. This field can be used in combination with birthMonth and birthYear.
                            title: Day of Birth
                            type: integer
                          birthDt:
                            description: The birthdate, in ISO-8601 YYYY-MM-DD format, of the entity being screened. If provided, this field must be valid for the screening request to succeed.
                            maxLength: 10
                            title: Date of Birth
                            type: string
                          birthMonth:
                            description: The numeric birth month for the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthYear.
                            title: Month of Birth
                            type: integer
                          birthYear:
                            description: The birth year of the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthMonth.
                            title: Year of Birth
                            type: integer
                        title: Date of Birth
                        type: object
                      firstName:
                        description: The first name or names of the party.
                        maxLength: 100
                        minLength: 2
                        title: First Name
                        type: string
                      gender:
                        description: For an individual party, the gender of the person.  If not specified or an unexpected value is supplied, the record is processed using "other". Valid values are "male", "female", and "other".
                        maxLength: 10
                        title: Gender
                        type: string
                      identity:
                        description: The attributes that correspond to an entity's proof of identity.
                        items:
                          properties:
                            countryOfIssue:
                              description: The numeric ISO code of the country that is associated with the supplied form of identification for the entity.
                              title: Country of Issue (ISO)
                              type: integer
                            countryOfIssueCode:
                              description: The ISO 3166 alphabetic code of the country that is associated with the supplied form of identification for the entity. This can be an Alpha-2 or Alpha-3 code.
                              maxLength: 3
                              title: Country of Issue Code
                              type: string
                            dateOfExpiry:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Expiry
                              type: string
                            dateOfIssue:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Issue
                              type: string
                            details:
                              description: Additional details for this form of identification.
                              maxLength: 100
                              title: Identity Details
                              type: string
                            issuedBy:
                              description: The entity that issued the identification.
                              maxLength: 36
                              title: Issued By
                              type: string
                            number:
                              description: The identifying number that is associated with the supplied form of identification for the entity. If a form of identity is provided, this field is required and must be valid for the screening request to succeed.
                              maxLength: 100
                              minLength: 1
                              title: Identity Number
                              type: string
                            type:
                              description: The type of identification that is supplied.
                              maxLength: 36
                              title: Identity Type
                              type: string
                            validFrom:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid From
                              type: string
                            validTo:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid To
                              type: string
                          required:
                            - number
                          type: object
                        maxItems: 100
                        title: Identity
                        type: array
                      label:
                        description: An optional label that is used to help identify the party's role or map the party's role to the original transaction object.
                        maxLength: 200
                        title: Label
                        type: string
                      name:
                        description: >
                          The name of the entity being screened. If this field is specified,

                          the surname and firstName fields are ignored. The value must be at least 2 characters and not more than 220 characters. For individuals, the

                          value is interpreted as a comma-delimited list of "surname, first name".
                        maxLength: 220
                        minLength: 2
                        title: Name
                        type: string
                      placeOfBirth:
                        description: Incoming data from the customers that contain information related to the place of birth of a party that is involved in a transaction.
                        properties:
                          addressLines:
                            description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                            items:
                              maxLength: 500
                              type: string
                            title: Address Lines
                            type: array
                          city:
                            description: The city in which the party was born.
                            maxLength: 100
                            title: City
                            type: string
                          countryCode:
                            description: The alphabetic ISO 3166 code of the country in which the party was born. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                            maxLength: 3
                            minLength: 2
                            title: Country Code
                            type: string
                          postCode:
                            description: The postcode or ZIP code in which the party was born.
                            maxLength: 36
                            title: Address Postcode
                            type: string
                          state:
                            description: An optional code or name of the state in which the party was born.
                            maxLength: 100
                            title: State
                            type: string
                          text:
                            description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                            maxLength: 500
                            title: Text
                            type: string
                        required:
                          - countryCode
                        title: Place of Birth
                        type: object
                      postalAddress:
                        description: Incoming data from the customers that contain information related to the postal address of a party that is involved in a transaction.
                        items:
                          properties:
                            addressLines:
                              description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                              items:
                                maxLength: 500
                                type: string
                              title: Address Lines
                              type: array
                            city:
                              description: The city in which the party is located.
                              maxLength: 100
                              title: City
                              type: string
                            countryCode:
                              description: The alphabetic ISO 3166 code of the country in which the party is located. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                              maxLength: 3
                              minLength: 2
                              title: Country Code
                              type: string
                            postCode:
                              description: The postcode or ZIP code in which the party is located.
                              maxLength: 36
                              title: Address Postcode
                              type: string
                            state:
                              description: An optional code or name of the state in which the party is located.
                              maxLength: 100
                              title: State
                              type: string
                            text:
                              description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                              maxLength: 500
                              title: Text
                              type: string
                          type: object
                        maxItems: 100
                        required:
                          - countryCode
                        title: Postal Address
                        type: array
                      screeningResult:
                        description: The result of a screening.
                        properties:
                          discardedHits:
                            description: The number of discarded hits against the entity that occurred during the screening request as a result of a screening exception.
                            title: Discarded Hits
                            type: integer
                            readOnly: true
                          hits:
                            description: The number of hits against the entity that occurred during the screening request.
                            title: Hits
                            type: integer
                            readOnly: true
                          maxScore:
                            title: Maximum Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.score of all of the matchedProfile records.
                            readOnly: true
                          primaryName:
                            title: Primary Name
                            type: string
                            description: For the screened entity, the matchedProfile.primaryName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          matchedName:
                            title: Matched name
                            type: string
                            description: For the screened entity, the matchedProfile.matchedName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          maxProximityScore:
                            title: Maximum Proximity Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.proximityScore of all of the matchedProfile records.
                            readOnly: true
                          matchedProfile:
                            description: The outcome data that is received from the watchlist screening engine when a hit occurs. This data is utilized in the alert generation process.
                            items:
                              properties:
                                categories:
                                  description: The list of categories assigned to the profile that is returned from the watchlist provider.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Categories
                                  type: array
                                checksum:
                                  description: A hash of the entire watchlist profile. This enables you to verify the value against your alerts database to determine if it has changed.
                                  title: Checksum
                                  type: integer
                                coreChecksum:
                                  description: The checksum value that is associated with the subset of profile data that constitutes important information. This changes only when properties that are part of the screening logic are changed. This includes names, addresses, IDs, date of birth, sanctions, and status.
                                  title: Core Checksum
                                  type: integer
                                dateOfBirth:
                                  description: The data provided about dates of birth.
                                  items:
                                    properties:
                                      birthDay:
                                        description: The day of birth.
                                        title: Day of Birth
                                        type: integer
                                      birthDt:
                                        description: The date of birth in ISO-8601 YYYY-MM-DD format.
                                        maxLength: 10
                                        readOnly: true
                                        title: Date of Birth
                                        type: string
                                      birthMonth:
                                        description: The month of birth.
                                        title: Month of Birth
                                        type: integer
                                      birthYear:
                                        description: The year of birth.
                                        title: Year of Birth
                                        type: integer
                                    type: object
                                  maxItems: 100
                                  title: Date of Birth
                                  type: array
                                geoScore:
                                  title: Geo Score
                                  description: A value that indicates the geographic degree of correspondence between the screened entity and the matched profile. A value of 0 indicates that no evidence was found. A value above 50 indicates that at least one country reference was found. Additional references further increase the score.
                                  type: integer
                                  readOnly: true
                                geoClues:
                                  title: Geo Clues
                                  description: A list of geographic references to the countries in the matched profiles.
                                  type: array
                                  items:
                                    maxLength: 200
                                    minLength: 1
                                    type: string
                                  maxItems: 100
                                  readOnly: true
                                exceptionId:
                                  description: The ID that is returned against an exception that is found and applied to a match. This internal ID is returned by the watchlist screening engine.
                                  maxLength: 50
                                  readOnly: true
                                  title: Exception ID
                                  type: string
                                exceptionReference:
                                  title: Exception Reference
                                  description: The reference ID that is associated with the exception. This is an internal identifier that is assigned when the exception is created.
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationPath:
                                  title: Location Path
                                  description: In a complex screened object (text or transaction), an indication as to where a match was found. For entity screening, the value is always '/'. For payment screening, the value is a screened field (such as '/debtor/name').
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationFrom:
                                  title: Location From
                                  description: In screened text, the 0-based start position where the match was found.
                                  type: integer
                                  readOnly: true
                                locationTo:
                                  title: Location To
                                  description: In screened text, the 0-based end position where the match was found.
                                  type: integer
                                  readOnly: true
                                mediaAgeScore:
                                  title: Media Age Score
                                  description: A score that indicates the age of the adverse media articles that are found in a profile.
                                  type: integer
                                  readOnly: true
                                mediaQuantityScore:
                                  title: Media Quantity Score
                                  description: A score that indicates the number of adverse media articles that were found in a watchlist profile as compared to the average number of adverse media reports for all profiles.
                                  type: integer
                                  readOnly: true
                                level:
                                  description: The strength of the hit. This is based on the elements that have matched (such as name, city, country, gender, DOB, ID). If a match occurs only on name, the level is always "low". Otherwise, the level corresponds to the highest level assigned to the matched criteria as defined in the metadata policies. If the match was ignored as a result of a screening exception, the level value is set to "discarded".
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Level
                                  type: string
                                links:
                                  description: The links to the watchlist profile resource and, if applicable, the screening exception resource that are related to the matched profile.
                                  items:
                                    properties:
                                      href:
                                        description: The URL for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: HREF
                                        type: string
                                      itemType:
                                        description: If this is a link to a container, itemType is the media type or link type for the items in the container.
                                        maxLength: 200
                                        readOnly: true
                                        title: Item Type
                                        type: string
                                      method:
                                        description: The HTTP method for the link.
                                        maxLength: 6
                                        minLength: 1
                                        readOnly: true
                                        title: Method
                                        type: string
                                      rel:
                                        description: The relationship of the link to the resource.
                                        maxLength: 50
                                        minLength: 1
                                        readOnly: true
                                        title: Relation Type
                                        type: string
                                      responseItemType:
                                        description: The media type or link type of the items in the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Item Type
                                        type: string
                                      responseType:
                                        description: The media type or link type of the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Type
                                        type: string
                                      title:
                                        description: The title for the link.
                                        maxLength: 100
                                        readOnly: true
                                        title: Title
                                        type: string
                                      type:
                                        description: The media type or link type for the link.
                                        maxLength: 200
                                        readOnly: true
                                        title: Media Type
                                        type: string
                                      uri:
                                        description: The relative URI for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: URI
                                        type: string
                                    type: object
                                  maxItems: 2
                                  required:
                                    - rel
                                  title: Links
                                  type: array
                                matchType:
                                  description: Provides an indication as to the basis of the type of matched data (name, ID, address, currency, country, web, etc.).
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Match Type
                                  type: string
                                matchedName:
                                  description: The name that matches the profile's primary name or one of its aliases.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Matched Name
                                  type: string
                                primaryName:
                                  description: The primary name of the matched profile.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Primary Name
                                  type: string
                                profileBirthPlaces:
                                  description: The data provided about birth places such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity was born.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity was born (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Birth Places
                                  type: array
                                profileGender:
                                  description: The gender of the matched profile, if known. Applies only for individuals.
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Gender
                                  type: string
                                profileId:
                                  description: The ID that is returned from the watchlist provider.
                                  maxLength: 100
                                  minLength: 1
                                  readOnly: true
                                  title: Profile ID
                                  type: string
                                profileIds:
                                  description: The list of all the IDs found in the profile that can potentially be matched with the IDs sent in the screened metadata.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile IDs
                                  type: array
                                profileLastUpdated:
                                  description: The timestamp of the profile's last update, in date-time format (RFC 3339).
                                  maxLength: 24
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Last Updated
                                  type: string
                                profilePlaces:
                                  description: The data provided about the location of the matched entity such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity is located.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity is located (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Places
                                  type: array
                                profileRelatedCountries:
                                  description: Other related countries of the matched profile (citizenships, incorporation, etc.).
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile Related Countries
                                  type: array
                                profileStatus:
                                  description: The status of the matched watchlist profile. The values indicate whether the record is active, inactive, deceased, or unknown.
                                  maxLength: 3
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Status
                                  type: string
                                profileType:
                                  description: The type of profile matched such as "individual", "entity", or "vessel".
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Type
                                  type: string
                                proximityScore:
                                  description: >-
                                    The proximity score with respect to a profile that is published by a watchlist.


                                    This attribute indicates how close a watchlist entry is to a sanctioned watchlist profile. Possible values include:


                                    100 - sanctioned profile


                                    80 - direct relationship with sanctioned profile


                                    50 - one relationship removed from a sanctioned profile


                                    0 - no relationship found


                                    null - undefined


                                    Note that all private list matches are returned as null (undefined).
                                  title: Proximity Score
                                  type: integer
                                  nullable: true
                                sanctions:
                                  description: The unique code of all the sanction lists in which this profile appears. These codes can be used in the "sanctions" preset field.
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Sanctions
                                  type: array
                                score:
                                  description: Indicates the confidence level of the match.
                                  title: Score
                                  type: integer
                                scoreScope:
                                  description: The list of matched metadata attributes such as DOB, city, country, gender, and ID.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Score Scope
                                  type: array
                                screened:
                                  description: >
                                    The text in the request in which the match was found. When screening names, this should be the same as the input string.

                                    When screening texts, this is a snippet containing the matched name.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Screened
                                  type: string
                                tags:
                                  description: >-
                                    Tags are used to indicate the type of list in which the record resides. It can also be used to indicate the entity type for the record.


                                    **List Types**:


                                    SAN = Sanctions Lists


                                    SIE = Special Interest Entity


                                    SIP = Special Interest Person


                                    PEP = Politically Exposed Person


                                    RCA = Relative or Close Associate


                                    SOC = State Owned Company


                                    OOL = Other Official Lists


                                    AM = Adverse Media


                                    BRD = Board Member


                                    **Entity Types**:


                                    LOC = Risk country


                                    VSL = Vessels


                                    AIR = Aircrafts


                                    For **Dow Jones Factiva**, see Description 1, Description 2, and Description 3.


                                    For **Refinitiv World-Check**, see Category and Sub-category.
                                  items:
                                    maxLength: 4
                                    minLength: 1
                                    type: string
                                  maxItems: 20
                                  title: Tags
                                  type: array
                              type: object
                            maxItems: 1000
                            title: Matched Profile
                            type: array
                            readOnly: true
                          messageReference:
                            description: The unique identifier that is generated by SAS Real-Time Watchlist Screening for a screening request. This value is populated in the screening response and is ignored on input.
                            maxLength: 36
                            minLength: 0
                            readOnly: true
                            title: Message Reference
                            type: string
                          statusCode:
                            description: >-
                              The status of a screening request at the record level.
                               •  Success = screening successful
                               •  Warning = screening successful with warnings
                               •  Validation Failure = screening request failure
                               •  Failure = screening response failure
                            maxLength: 18
                            minLength: 7
                            readOnly: true
                            title: Status Code
                            type: string
                        readOnly: true
                        title: Screening Result
                        type: object
                      surname:
                        description: The surname of the entity being screened. If used with firstName, the two fields are combined to form the full name of the entity. The value must be at least 2 characters and not more than 100 characters.
                        maxLength: 100
                        minLength: 2
                        title: Surname
                        type: string
                      text:
                        description: The party information as unstructured data.  If the name field is specified, this field is ignored.
                        maxLength: 1000
                        title: Text
                        type: string
                    title: Initiating Party
                    type: object
                  intermediaries:
                    description: Intermediary information.
                    items:
                      properties:
                        account:
                          description: Incoming data from the customers that contain information that is related to a transaction.
                          properties:
                            currency:
                              description: The 3-digit alphabetic ISO currency code that is associated with the account.
                              maxLength: 3
                              minLength: 3
                              title: Currency
                              type: string
                            name:
                              description: The name of the account, as assigned by the account servicing institution. This provides an additional means of identification for the account.
                              maxLength: 200
                              title: Name
                              type: string
                            number:
                              description: The unique identifier that is associated with the account. This field is required and must be between 1 and 100 characters in length.
                              maxLength: 100
                              minLength: 1
                              title: Account Number
                              type: string
                            proxy:
                              description: An alternate assumed name for the identification of the account.
                              maxLength: 200
                              title: Proxy
                              type: string
                            type:
                              description: The type of the account (for example, savings, checking, and so on).
                              maxLength: 200
                              title: Account Type
                              type: string
                          required:
                            - number
                          title: Account
                          type: object
                        dateOfBirth:
                          description: >-
                            A supplied birthdate for the entity being screened. This object is used only when the type of entity being screened is "individual".

                            * If the birthtDt field is supplied, the birthDay, birthMonth, and birthYear fields are not used in the screening request.

                            * If the birthDt field is not supplied, an attempt is made to interpret the birthDay, birthMonth, and birthYear as a date, and use that in the screening request.

                            * If the birthDay or birthMonth are not specified, only the birthYear is used in the screening request.
                          properties:
                            birthDay:
                              description: The numeric birth day of the month for the entity being screened. This field can be used in combination with birthMonth and birthYear.
                              title: Day of Birth
                              type: integer
                            birthDt:
                              description: The birthdate, in ISO-8601 YYYY-MM-DD format, of the entity being screened. If provided, this field must be valid for the screening request to succeed.
                              maxLength: 10
                              title: Date of Birth
                              type: string
                            birthMonth:
                              description: The numeric birth month for the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthYear.
                              title: Month of Birth
                              type: integer
                            birthYear:
                              description: The birth year of the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthMonth.
                              title: Year of Birth
                              type: integer
                          title: Date of Birth
                          type: object
                        firstName:
                          description: The first name or names of the party.
                          maxLength: 100
                          minLength: 2
                          title: First Name
                          type: string
                        gender:
                          description: For an individual party, the gender of the person.  If not specified or an unexpected value is supplied, the record is processed using "other". Valid values are "male", "female", and "other".
                          maxLength: 10
                          title: Gender
                          type: string
                        identity:
                          description: The attributes that correspond to an entity's proof of identity.
                          items:
                            properties:
                              countryOfIssue:
                                description: The numeric ISO code of the country that is associated with the supplied form of identification for the entity.
                                title: Country of Issue (ISO)
                                type: integer
                              countryOfIssueCode:
                                description: The ISO 3166 alphabetic code of the country that is associated with the supplied form of identification for the entity. This can be an Alpha-2 or Alpha-3 code.
                                maxLength: 3
                                title: Country of Issue Code
                                type: string
                              dateOfExpiry:
                                description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                                maxLength: 10
                                title: Date of Expiry
                                type: string
                              dateOfIssue:
                                description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                                maxLength: 10
                                title: Date of Issue
                                type: string
                              details:
                                description: Additional details for this form of identification.
                                maxLength: 100
                                title: Identity Details
                                type: string
                              issuedBy:
                                description: The entity that issued the identification.
                                maxLength: 36
                                title: Issued By
                                type: string
                              number:
                                description: The identifying number that is associated with the supplied form of identification for the entity. If a form of identity is provided, this field is required and must be valid for the screening request to succeed.
                                maxLength: 100
                                minLength: 1
                                title: Identity Number
                                type: string
                              type:
                                description: The type of identification that is supplied.
                                maxLength: 36
                                title: Identity Type
                                type: string
                              validFrom:
                                description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                                maxLength: 10
                                title: Valid From
                                type: string
                              validTo:
                                description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                                maxLength: 10
                                title: Valid To
                                type: string
                            required:
                              - number
                            type: object
                          maxItems: 100
                          title: Identity
                          type: array
                        label:
                          description: An optional label that is used to help identify the party's role or map the party's role to the original transaction object.
                          maxLength: 200
                          title: Label
                          type: string
                        name:
                          description: >
                            The name of the entity being screened. If this field is specified,

                            the surname and firstName fields are ignored. The value must be at least 2 characters and not more than 220 characters. For individuals, the

                            value is interpreted as a comma-delimited list of "surname, first name".
                          maxLength: 220
                          minLength: 2
                          title: Name
                          type: string
                        placeOfBirth:
                          description: Incoming data from the customers that contain information related to the place of birth of a party that is involved in a transaction.
                          properties:
                            addressLines:
                              description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                              items:
                                maxLength: 500
                                type: string
                              title: Address Lines
                              type: array
                            city:
                              description: The city in which the party was born.
                              maxLength: 100
                              title: City
                              type: string
                            countryCode:
                              description: The alphabetic ISO 3166 code of the country in which the party was born. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                              maxLength: 3
                              minLength: 2
                              title: Country Code
                              type: string
                            postCode:
                              description: The postcode or ZIP code in which the party was born.
                              maxLength: 36
                              title: Address Postcode
                              type: string
                            state:
                              description: An optional code or name of the state in which the party was born.
                              maxLength: 100
                              title: State
                              type: string
                            text:
                              description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                              maxLength: 500
                              title: Text
                              type: string
                          required:
                            - countryCode
                          title: Place of Birth
                          type: object
                        postalAddress:
                          description: Incoming data from the customers that contain information related to the postal address of a party that is involved in a transaction.
                          items:
                            properties:
                              addressLines:
                                description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                                items:
                                  maxLength: 500
                                  type: string
                                title: Address Lines
                                type: array
                              city:
                                description: The city in which the party is located.
                                maxLength: 100
                                title: City
                                type: string
                              countryCode:
                                description: The alphabetic ISO 3166 code of the country in which the party is located. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                                maxLength: 3
                                minLength: 2
                                title: Country Code
                                type: string
                              postCode:
                                description: The postcode or ZIP code in which the party is located.
                                maxLength: 36
                                title: Address Postcode
                                type: string
                              state:
                                description: An optional code or name of the state in which the party is located.
                                maxLength: 100
                                title: State
                                type: string
                              text:
                                description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                                maxLength: 500
                                title: Text
                                type: string
                            type: object
                          maxItems: 100
                          required:
                            - countryCode
                          title: Postal Address
                          type: array
                        screeningResult:
                          description: The result of a screening.
                          properties:
                            discardedHits:
                              description: The number of discarded hits against the entity that occurred during the screening request as a result of a screening exception.
                              title: Discarded Hits
                              type: integer
                              readOnly: true
                            hits:
                              description: The number of hits against the entity that occurred during the screening request.
                              title: Hits
                              type: integer
                              readOnly: true
                            maxScore:
                              title: Maximum Score
                              type: integer
                              description: For the screened entity, the highest matchProfile.score of all of the matchedProfile records.
                              readOnly: true
                            primaryName:
                              title: Primary Name
                              type: string
                              description: For the screened entity, the matchedProfile.primaryName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                              readOnly: true
                              maxLength: 50
                            matchedName:
                              title: Matched name
                              type: string
                              description: For the screened entity, the matchedProfile.matchedName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                              readOnly: true
                              maxLength: 50
                            maxProximityScore:
                              title: Maximum Proximity Score
                              type: integer
                              description: For the screened entity, the highest matchProfile.proximityScore of all of the matchedProfile records.
                              readOnly: true
                            matchedProfile:
                              description: The outcome data that is received from the watchlist screening engine when a hit occurs. This data is utilized in the alert generation process.
                              items:
                                properties:
                                  categories:
                                    description: The list of categories assigned to the profile that is returned from the watchlist provider.
                                    items:
                                      maxLength: 50
                                      minLength: 1
                                      type: string
                                    maxItems: 50
                                    title: Categories
                                    type: array
                                  checksum:
                                    description: A hash of the entire watchlist profile. This enables you to verify the value against your alerts database to determine if it has changed.
                                    title: Checksum
                                    type: integer
                                  coreChecksum:
                                    description: The checksum value that is associated with the subset of profile data that constitutes important information. This changes only when properties that are part of the screening logic are changed. This includes names, addresses, IDs, date of birth, sanctions, and status.
                                    title: Core Checksum
                                    type: integer
                                  dateOfBirth:
                                    description: The data provided about dates of birth.
                                    items:
                                      properties:
                                        birthDay:
                                          description: The day of birth.
                                          title: Day of Birth
                                          type: integer
                                        birthDt:
                                          description: The date of birth in ISO-8601 YYYY-MM-DD format.
                                          maxLength: 10
                                          readOnly: true
                                          title: Date of Birth
                                          type: string
                                        birthMonth:
                                          description: The month of birth.
                                          title: Month of Birth
                                          type: integer
                                        birthYear:
                                          description: The year of birth.
                                          title: Year of Birth
                                          type: integer
                                      type: object
                                    maxItems: 100
                                    title: Date of Birth
                                    type: array
                                  geoScore:
                                    title: Geo Score
                                    description: A value that indicates the geographic degree of correspondence between the screened entity and the matched profile. A value of 0 indicates that no evidence was found. A value above 50 indicates that at least one country reference was found. Additional references further increase the score.
                                    type: integer
                                    readOnly: true
                                  geoClues:
                                    title: Geo Clues
                                    description: A list of geographic references to the countries in the matched profiles.
                                    type: array
                                    items:
                                      maxLength: 200
                                      minLength: 1
                                      type: string
                                    maxItems: 100
                                    readOnly: true
                                  exceptionId:
                                    description: The ID that is returned against an exception that is found and applied to a match. This internal ID is returned by the watchlist screening engine.
                                    maxLength: 50
                                    readOnly: true
                                    title: Exception ID
                                    type: string
                                  exceptionReference:
                                    title: Exception Reference
                                    description: The reference ID that is associated with the exception. This is an internal identifier that is assigned when the exception is created.
                                    type: string
                                    minLength: 0
                                    maxLength: 200
                                    readOnly: true
                                  locationPath:
                                    title: Location Path
                                    description: In a complex screened object (text or transaction), an indication as to where a match was found. For entity screening, the value is always '/'. For payment screening, the value is a screened field (such as '/debtor/name').
                                    type: string
                                    minLength: 0
                                    maxLength: 200
                                    readOnly: true
                                  locationFrom:
                                    title: Location From
                                    description: In screened text, the 0-based start position where the match was found.
                                    type: integer
                                    readOnly: true
                                  locationTo:
                                    title: Location To
                                    description: In screened text, the 0-based end position where the match was found.
                                    type: integer
                                    readOnly: true
                                  mediaAgeScore:
                                    title: Media Age Score
                                    description: A score that indicates the age of the adverse media articles that are found in a profile.
                                    type: integer
                                    readOnly: true
                                  mediaQuantityScore:
                                    title: Media Quantity Score
                                    description: A score that indicates the number of adverse media articles that were found in a watchlist profile as compared to the average number of adverse media reports for all profiles.
                                    type: integer
                                    readOnly: true
                                  level:
                                    description: The strength of the hit. This is based on the elements that have matched (such as name, city, country, gender, DOB, ID). If a match occurs only on name, the level is always "low". Otherwise, the level corresponds to the highest level assigned to the matched criteria as defined in the metadata policies. If the match was ignored as a result of a screening exception, the level value is set to "discarded".
                                    maxLength: 10
                                    minLength: 1
                                    readOnly: true
                                    title: Level
                                    type: string
                                  links:
                                    description: The links to the watchlist profile resource and, if applicable, the screening exception resource that are related to the matched profile.
                                    items:
                                      properties:
                                        href:
                                          description: The URL for the link.
                                          maxLength: 500
                                          minLength: 1
                                          readOnly: true
                                          title: HREF
                                          type: string
                                        itemType:
                                          description: If this is a link to a container, itemType is the media type or link type for the items in the container.
                                          maxLength: 200
                                          readOnly: true
                                          title: Item Type
                                          type: string
                                        method:
                                          description: The HTTP method for the link.
                                          maxLength: 6
                                          minLength: 1
                                          readOnly: true
                                          title: Method
                                          type: string
                                        rel:
                                          description: The relationship of the link to the resource.
                                          maxLength: 50
                                          minLength: 1
                                          readOnly: true
                                          title: Relation Type
                                          type: string
                                        responseItemType:
                                          description: The media type or link type of the items in the response body for a PUT, POST, or PATCH operation.
                                          maxLength: 200
                                          readOnly: true
                                          title: Response Item Type
                                          type: string
                                        responseType:
                                          description: The media type or link type of the response body for a PUT, POST, or PATCH operation.
                                          maxLength: 200
                                          readOnly: true
                                          title: Response Type
                                          type: string
                                        title:
                                          description: The title for the link.
                                          maxLength: 100
                                          readOnly: true
                                          title: Title
                                          type: string
                                        type:
                                          description: The media type or link type for the link.
                                          maxLength: 200
                                          readOnly: true
                                          title: Media Type
                                          type: string
                                        uri:
                                          description: The relative URI for the link.
                                          maxLength: 500
                                          minLength: 1
                                          readOnly: true
                                          title: URI
                                          type: string
                                      type: object
                                    maxItems: 2
                                    required:
                                      - rel
                                    title: Links
                                    type: array
                                  matchType:
                                    description: Provides an indication as to the basis of the type of matched data (name, ID, address, currency, country, web, etc.).
                                    maxLength: 15
                                    minLength: 1
                                    readOnly: true
                                    title: Match Type
                                    type: string
                                  matchedName:
                                    description: The name that matches the profile's primary name or one of its aliases.
                                    maxLength: 50
                                    minLength: 1
                                    readOnly: true
                                    title: Matched Name
                                    type: string
                                  primaryName:
                                    description: The primary name of the matched profile.
                                    maxLength: 50
                                    minLength: 1
                                    readOnly: true
                                    title: Primary Name
                                    type: string
                                  profileBirthPlaces:
                                    description: The data provided about birth places such as city and country.
                                    items:
                                      properties:
                                        city:
                                          description: The city in which the matched entity was born.
                                          maxLength: 100
                                          readOnly: true
                                          title: City
                                          type: string
                                        countryCode:
                                          description: The country in which the matched entity was born (ISO2 code).
                                          maxLength: 2
                                          readOnly: true
                                          title: Country Code
                                          type: string
                                      type: object
                                    maxItems: 100
                                    title: Profile Birth Places
                                    type: array
                                  profileGender:
                                    description: The gender of the matched profile, if known. Applies only for individuals.
                                    maxLength: 10
                                    minLength: 1
                                    readOnly: true
                                    title: Profile Gender
                                    type: string
                                  profileId:
                                    description: The ID that is returned from the watchlist provider.
                                    maxLength: 100
                                    minLength: 1
                                    readOnly: true
                                    title: Profile ID
                                    type: string
                                  profileIds:
                                    description: The list of all the IDs found in the profile that can potentially be matched with the IDs sent in the screened metadata.
                                    items:
                                      maxLength: 50
                                      minLength: 1
                                      type: string
                                    maxItems: 50
                                    title: Profile IDs
                                    type: array
                                  profileLastUpdated:
                                    description: The timestamp of the profile's last update, in date-time format (RFC 3339).
                                    maxLength: 24
                                    minLength: 1
                                    readOnly: true
                                    title: Profile Last Updated
                                    type: string
                                  profilePlaces:
                                    description: The data provided about the location of the matched entity such as city and country.
                                    items:
                                      properties:
                                        city:
                                          description: The city in which the matched entity is located.
                                          maxLength: 100
                                          readOnly: true
                                          title: City
                                          type: string
                                        countryCode:
                                          description: The country in which the matched entity is located (ISO2 code).
                                          maxLength: 2
                                          readOnly: true
                                          title: Country Code
                                          type: string
                                      type: object
                                    maxItems: 100
                                    title: Profile Places
                                    type: array
                                  profileRelatedCountries:
                                    description: Other related countries of the matched profile (citizenships, incorporation, etc.).
                                    items:
                                      maxLength: 20
                                      minLength: 1
                                      type: string
                                    maxItems: 50
                                    title: Profile Related Countries
                                    type: array
                                  profileStatus:
                                    description: The status of the matched watchlist profile. The values indicate whether the record is active, inactive, deceased, or unknown.
                                    maxLength: 3
                                    minLength: 1
                                    readOnly: true
                                    title: Profile Status
                                    type: string
                                  profileType:
                                    description: The type of profile matched such as "individual", "entity", or "vessel".
                                    maxLength: 15
                                    minLength: 1
                                    readOnly: true
                                    title: Profile Type
                                    type: string
                                  proximityScore:
                                    description: >-
                                      The proximity score with respect to a profile that is published by a watchlist.


                                      This attribute indicates how close a watchlist entry is to a sanctioned watchlist profile. Possible values include:


                                      100 - sanctioned profile


                                      80 - direct relationship with sanctioned profile


                                      50 - one relationship removed from a sanctioned profile


                                      0 - no relationship found


                                      null - undefined


                                      Note that all private list matches are returned as null (undefined).
                                    title: Proximity Score
                                    type: integer
                                    nullable: true
                                  sanctions:
                                    description: The unique code of all the sanction lists in which this profile appears. These codes can be used in the "sanctions" preset field.
                                    items:
                                      maxLength: 20
                                      minLength: 1
                                      type: string
                                    maxItems: 50
                                    title: Sanctions
                                    type: array
                                  score:
                                    description: Indicates the confidence level of the match.
                                    title: Score
                                    type: integer
                                  scoreScope:
                                    description: The list of matched metadata attributes such as DOB, city, country, gender, and ID.
                                    items:
                                      maxLength: 50
                                      minLength: 1
                                      type: string
                                    maxItems: 50
                                    title: Score Scope
                                    type: array
                                  screened:
                                    description: >
                                      The text in the request in which the match was found. When screening names, this should be the same as the input string.

                                      When screening texts, this is a snippet containing the matched name.
                                    maxLength: 50
                                    minLength: 1
                                    readOnly: true
                                    title: Screened
                                    type: string
                                  tags:
                                    description: >-
                                      Tags are used to indicate the type of list in which the record resides. It can also be used to indicate the entity type for the record.


                                      **List Types**:


                                      SAN = Sanctions Lists


                                      SIE = Special Interest Entity


                                      SIP = Special Interest Person


                                      PEP = Politically Exposed Person


                                      RCA = Relative or Close Associate


                                      SOC = State Owned Company


                                      OOL = Other Official Lists


                                      AM = Adverse Media


                                      BRD = Board Member


                                      **Entity Types**:


                                      LOC = Risk country


                                      VSL = Vessels


                                      AIR = Aircrafts


                                      For **Dow Jones Factiva**, see Description 1, Description 2, and Description 3.


                                      For **Refinitiv World-Check**, see Category and Sub-category.
                                    items:
                                      maxLength: 4
                                      minLength: 1
                                      type: string
                                    maxItems: 20
                                    title: Tags
                                    type: array
                                type: object
                              maxItems: 1000
                              title: Matched Profile
                              type: array
                              readOnly: true
                            messageReference:
                              description: The unique identifier that is generated by SAS Real-Time Watchlist Screening for a screening request. This value is populated in the screening response and is ignored on input.
                              maxLength: 36
                              minLength: 0
                              readOnly: true
                              title: Message Reference
                              type: string
                            statusCode:
                              description: >-
                                The status of a screening request at the record level.

                                •  Success = screening successful

                                •  Warning = screening successful with warnings

                                •  Validation Failure = screening request failure

                                •  Failure = screening response failure
                              maxLength: 18
                              minLength: 7
                              readOnly: true
                              title: Status Code
                              type: string
                          readOnly: true
                          title: Screening Result
                          type: object
                        surname:
                          description: The surname of the entity being screened. If used with firstName, the two fields are combined to form the full name of the entity. The value must be at least 2 characters and not more than 100 characters.
                          maxLength: 100
                          minLength: 2
                          title: Surname
                          type: string
                        text:
                          description: The party information as unstructured data.  If the name field is specified, this field is ignored.
                          maxLength: 1000
                          title: Text
                          type: string
                    title: Intermediaries
                    type: array
                  messageContent:
                    description: The message file content. This field is ignored if structured party data is included in the message.
                    maxLength: 10000
                    title: Message Content
                    type: string
                  messageFormat:
                    description: >-
                      The format of the payment to be screened. If message content is provided, a value is required for this field. Valid values are as follows:

                      * MX

                      * MT
                    maxLength: 5
                    title: Message Format
                    type: string
                  purpose:
                    description: "The underlying reason for the payment. "
                    maxLength: 200
                    title: Purpose
                    type: string
                  screeningResult:
                    description: The result of a screening.
                    properties:
                      discardedHits:
                        description: The number of discarded hits against the payment that occurred during the screening request as a result of a screening exception.
                        title: Discarded Hits
                        type: integer
                        readOnly: true
                      hits:
                        description: The number of hits against the payment that occurred during the screening request.
                        title: Hits
                        type: integer
                        readOnly: true
                      maxScore:
                        title: Maximum Score
                        type: integer
                        description: For the screened entity, the highest matchProfile.score of all of the matchedProfile records.
                        readOnly: true
                      primaryName:
                        title: Primary Name
                        type: string
                        description: For the screened entity, the matchedProfile.primaryName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                        readOnly: true
                        maxLength: 50
                      matchedName:
                        title: Matched name
                        type: string
                        description: For the screened entity, the matchedProfile.matchedName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                        readOnly: true
                        maxLength: 50
                      maxProximityScore:
                        title: Maximum Proximity Score
                        type: integer
                        description: For the screened entity, the highest matchProfile.proximityScore of all of the matchedProfile records.
                        readOnly: true
                      remainingHits:
                        title: Remaining Hits
                        type: integer
                        description: For all the entities that are associated with a payment, the total number of profile hits.  This is calculated by subtracting the total number of discarded hits from the total number of hits.
                        readOnly: true
                      messageReference:
                        description: The unique identifier that is generated by SAS Real-Time Watchlist Screening for a screening request. This value is populated in the screening response and is ignored on input.
                        maxLength: 36
                        minLength: 0
                        readOnly: true
                        title: Message Reference
                        type: string
                      notifications:
                        description: All error and warning messages that are involved in the respective context of the screening process.
                        properties:
                          errors:
                            description: Errors that occurred during processing.
                            items:
                              maxLength: 500
                              type: string
                            maxItems: 50
                            title: Errors
                            type: array
                          warnings:
                            description: Warnings that occurred during processing.
                            items:
                              maxLength: 500
                              type: string
                            maxItems: 50
                            title: Warnings
                            type: array
                        title: Notifications
                        type: object
                      statusCode:
                        description: >-
                          The status of a screening request at the record level.
                           •  Success = screening successful
                           •  Warning = screening successful with warnings
                           •  Validation Failure = screening request failure
                           •  Failure = screening response failure
                        maxLength: 18
                        minLength: 7
                        readOnly: true
                        title: Status Code
                        type: string
                    readOnly: true
                    title: Screening Result
                    type: object
                  transactionDttm:
                    description: The date and time, in ISO-8601 format, that the payment was initiated.
                    title: Transaction Datetime
                    type: string
                  transactionId:
                    description: "The unique identifier that is associated with the payment being screened. "
                    maxLength: 100
                    title: Transaction ID
                    type: string
                  transactionType:
                    description: The type of payment being screened, such as customer credit transfer.
                    maxLength: 100
                    title: Transaction Type
                    type: string
                  ultimateCreditor:
                    description: Ultimate creditor information.
                    properties:
                      account:
                        description: Incoming data from the customers that contain information that is related to a transaction.
                        properties:
                          currency:
                            description: The 3-digit alphabetic ISO currency code that is associated with the account.
                            maxLength: 3
                            minLength: 3
                            title: Currency
                            type: string
                          name:
                            description: The name of the account, as assigned by the account servicing institution. This provides an additional means of identification for the account.
                            maxLength: 200
                            title: Name
                            type: string
                          number:
                            description: The unique identifier that is associated with the account. This field is required and must be between 1 and 100 characters in length.
                            maxLength: 100
                            minLength: 1
                            title: Account Number
                            type: string
                          proxy:
                            description: An alternate assumed name for the identification of the account.
                            maxLength: 200
                            title: Proxy
                            type: string
                          type:
                            description: The type of the account (for example, savings, checking, and so on).
                            maxLength: 200
                            title: Account Type
                            type: string
                        required:
                          - number
                        title: Account
                        type: object
                      dateOfBirth:
                        description: >-
                          A supplied birthdate for the entity being screened. This object is used only when the type of entity being screened is "individual".

                          * If the birthtDt field is supplied, the birthDay, birthMonth, and birthYear fields are not used in the screening request.

                          * If the birthDt field is not supplied, an attempt is made to interpret the birthDay, birthMonth, and birthYear as a date, and use that in the screening request.

                          * If the birthDay or birthMonth are not specified, only the birthYear is used in the screening request.
                        properties:
                          birthDay:
                            description: The numeric birth day of the month for the entity being screened. This field can be used in combination with birthMonth and birthYear.
                            title: Day of Birth
                            type: integer
                          birthDt:
                            description: The birthdate, in ISO-8601 YYYY-MM-DD format, of the entity being screened. If provided, this field must be valid for the screening request to succeed.
                            maxLength: 10
                            title: Date of Birth
                            type: string
                          birthMonth:
                            description: The numeric birth month for the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthYear.
                            title: Month of Birth
                            type: integer
                          birthYear:
                            description: The birth year of the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthMonth.
                            title: Year of Birth
                            type: integer
                        title: Date of Birth
                        type: object
                      firstName:
                        description: The first name or names of the party.
                        maxLength: 100
                        minLength: 2
                        title: First Name
                        type: string
                      gender:
                        description: For an individual party, the gender of the person.  If not specified or an unexpected value is supplied, the record is processed using "other". Valid values are "male", "female", and "other".
                        maxLength: 10
                        title: Gender
                        type: string
                      identity:
                        description: The attributes that correspond to an entity's proof of identity.
                        items:
                          properties:
                            countryOfIssue:
                              description: The numeric ISO code of the country that is associated with the supplied form of identification for the entity.
                              title: Country of Issue (ISO)
                              type: integer
                            countryOfIssueCode:
                              description: The ISO 3166 alphabetic code of the country that is associated with the supplied form of identification for the entity. This can be an Alpha-2 or Alpha-3 code.
                              maxLength: 3
                              title: Country of Issue Code
                              type: string
                            dateOfExpiry:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Expiry
                              type: string
                            dateOfIssue:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Issue
                              type: string
                            details:
                              description: Additional details for this form of identification.
                              maxLength: 100
                              title: Identity Details
                              type: string
                            issuedBy:
                              description: The entity that issued the identification.
                              maxLength: 36
                              title: Issued By
                              type: string
                            number:
                              description: The identifying number that is associated with the supplied form of identification for the entity. If a form of identity is provided, this field is required and must be valid for the screening request to succeed.
                              maxLength: 100
                              minLength: 1
                              title: Identity Number
                              type: string
                            type:
                              description: The type of identification that is supplied.
                              maxLength: 36
                              title: Identity Type
                              type: string
                            validFrom:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid From
                              type: string
                            validTo:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid To
                              type: string
                          required:
                            - number
                          type: object
                        maxItems: 100
                        title: Identity
                        type: array
                      label:
                        description: An optional label that is used to help identify the party's role or map the party's role to the original transaction object.
                        maxLength: 200
                        title: Label
                        type: string
                      name:
                        description: >
                          The name of the entity being screened. If this field is specified,

                          the surname and firstName fields are ignored. The value must be at least 2 characters and not more than 220 characters. For individuals, the

                          value is interpreted as a comma-delimited list of "surname, first name".
                        maxLength: 220
                        minLength: 2
                        title: Name
                        type: string
                      placeOfBirth:
                        description: Incoming data from the customers that contain information related to the place of birth of a party that is involved in a transaction.
                        properties:
                          addressLines:
                            description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                            items:
                              maxLength: 500
                              type: string
                            title: Address Lines
                            type: array
                          city:
                            description: The city in which the party was born.
                            maxLength: 100
                            title: City
                            type: string
                          countryCode:
                            description: The alphabetic ISO 3166 code of the country in which the party was born. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                            maxLength: 3
                            minLength: 2
                            title: Country Code
                            type: string
                          postCode:
                            description: The postcode or ZIP code in which the party was born.
                            maxLength: 36
                            title: Address Postcode
                            type: string
                          state:
                            description: An optional code or name of the state in which the party was born.
                            maxLength: 100
                            title: State
                            type: string
                          text:
                            description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                            maxLength: 500
                            title: Text
                            type: string
                        required:
                          - countryCode
                        title: Place of Birth
                        type: object
                      postalAddress:
                        description: Incoming data from the customers that contain information related to the postal address of a party that is involved in a transaction.
                        items:
                          properties:
                            addressLines:
                              description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                              items:
                                maxLength: 500
                                type: string
                              title: Address Lines
                              type: array
                            city:
                              description: The city in which the party is located.
                              maxLength: 100
                              title: City
                              type: string
                            countryCode:
                              description: The alphabetic ISO 3166 code of the country in which the party is located. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                              maxLength: 3
                              minLength: 2
                              title: Country Code
                              type: string
                            postCode:
                              description: The postcode or ZIP code in which the party is located.
                              maxLength: 36
                              title: Address Postcode
                              type: string
                            state:
                              description: An optional code or name of the state in which the party is located.
                              maxLength: 100
                              title: State
                              type: string
                            text:
                              description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                              maxLength: 500
                              title: Text
                              type: string
                          type: object
                        maxItems: 100
                        required:
                          - countryCode
                        title: Postal Address
                        type: array
                      screeningResult:
                        description: The result of a screening.
                        properties:
                          discardedHits:
                            description: The number of discarded hits against the entity that occurred during the screening request as a result of a screening exception.
                            title: Discarded Hits
                            type: integer
                            readOnly: true
                          hits:
                            description: The number of hits against the entity that occurred during the screening request.
                            title: Hits
                            type: integer
                            readOnly: true
                          maxScore:
                            title: Maximum Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.score of all of the matchedProfile records.
                            readOnly: true
                          primaryName:
                            title: Primary Name
                            type: string
                            description: For the screened entity, the matchedProfile.primaryName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          matchedName:
                            title: Matched name
                            type: string
                            description: For the screened entity, the matchedProfile.matchedName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          maxProximityScore:
                            title: Maximum Proximity Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.proximityScore of all of the matchedProfile records.
                            readOnly: true
                          matchedProfile:
                            description: The outcome data that is received from the watchlist screening engine when a hit occurs. This data is utilized in the alert generation process.
                            items:
                              properties:
                                categories:
                                  description: The list of categories assigned to the profile that is returned from the watchlist provider.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Categories
                                  type: array
                                checksum:
                                  description: A hash of the entire watchlist profile. This enables you to verify the value against your alerts database to determine if it has changed.
                                  title: Checksum
                                  type: integer
                                coreChecksum:
                                  description: The checksum value that is associated with the subset of profile data that constitutes important information. This changes only when properties that are part of the screening logic are changed. This includes names, addresses, IDs, date of birth, sanctions, and status.
                                  title: Core Checksum
                                  type: integer
                                dateOfBirth:
                                  description: The data provided about dates of birth.
                                  items:
                                    properties:
                                      birthDay:
                                        description: The day of birth.
                                        title: Day of Birth
                                        type: integer
                                      birthDt:
                                        description: The date of birth in ISO-8601 YYYY-MM-DD format.
                                        maxLength: 10
                                        readOnly: true
                                        title: Date of Birth
                                        type: string
                                      birthMonth:
                                        description: The month of birth.
                                        title: Month of Birth
                                        type: integer
                                      birthYear:
                                        description: The year of birth.
                                        title: Year of Birth
                                        type: integer
                                    type: object
                                  maxItems: 100
                                  title: Date of Birth
                                  type: array
                                geoScore:
                                  title: Geo Score
                                  description: A value that indicates the geographic degree of correspondence between the screened entity and the matched profile. A value of 0 indicates that no evidence was found. A value above 50 indicates that at least one country reference was found. Additional references further increase the score.
                                  type: integer
                                  readOnly: true
                                geoClues:
                                  title: Geo Clues
                                  description: A list of geographic references to the countries in the matched profiles.
                                  type: array
                                  items:
                                    maxLength: 200
                                    minLength: 1
                                    type: string
                                  maxItems: 100
                                  readOnly: true
                                exceptionId:
                                  description: The ID that is returned against an exception that is found and applied to a match. This internal ID is returned by the watchlist screening engine.
                                  maxLength: 50
                                  readOnly: true
                                  title: Exception ID
                                  type: string
                                exceptionReference:
                                  title: Exception Reference
                                  description: The reference ID that is associated with the exception. This is an internal identifier that is assigned when the exception is created.
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationPath:
                                  title: Location Path
                                  description: In a complex screened object (text or transaction), an indication as to where a match was found. For entity screening, the value is always '/'. For payment screening, the value is a screened field (such as '/debtor/name').
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationFrom:
                                  title: Location From
                                  description: In screened text, the 0-based start position where the match was found.
                                  type: integer
                                  readOnly: true
                                locationTo:
                                  title: Location To
                                  description: In screened text, the 0-based end position where the match was found.
                                  type: integer
                                  readOnly: true
                                mediaAgeScore:
                                  title: Media Age Score
                                  description: A score that indicates the age of the adverse media articles that are found in a profile.
                                  type: integer
                                  readOnly: true
                                mediaQuantityScore:
                                  title: Media Quantity Score
                                  description: A score that indicates the number of adverse media articles that were found in a watchlist profile as compared to the average number of adverse media reports for all profiles.
                                  type: integer
                                  readOnly: true
                                level:
                                  description: The strength of the hit. This is based on the elements that have matched (such as name, city, country, gender, DOB, ID). If a match occurs only on name, the level is always "low". Otherwise, the level corresponds to the highest level assigned to the matched criteria as defined in the metadata policies. If the match was ignored as a result of a screening exception, the level value is set to "discarded".
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Level
                                  type: string
                                links:
                                  description: The links to the watchlist profile resource and, if applicable, the screening exception resource that are related to the matched profile.
                                  items:
                                    properties:
                                      href:
                                        description: The URL for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: HREF
                                        type: string
                                      itemType:
                                        description: If this is a link to a container, itemType is the media type or link type for the items in the container.
                                        maxLength: 200
                                        readOnly: true
                                        title: Item Type
                                        type: string
                                      method:
                                        description: The HTTP method for the link.
                                        maxLength: 6
                                        minLength: 1
                                        readOnly: true
                                        title: Method
                                        type: string
                                      rel:
                                        description: The relationship of the link to the resource.
                                        maxLength: 50
                                        minLength: 1
                                        readOnly: true
                                        title: Relation Type
                                        type: string
                                      responseItemType:
                                        description: The media type or link type of the items in the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Item Type
                                        type: string
                                      responseType:
                                        description: The media type or link type of the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Type
                                        type: string
                                      title:
                                        description: The title for the link.
                                        maxLength: 100
                                        readOnly: true
                                        title: Title
                                        type: string
                                      type:
                                        description: The media type or link type for the link.
                                        maxLength: 200
                                        readOnly: true
                                        title: Media Type
                                        type: string
                                      uri:
                                        description: The relative URI for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: URI
                                        type: string
                                    type: object
                                  maxItems: 2
                                  required:
                                    - rel
                                  title: Links
                                  type: array
                                matchType:
                                  description: Provides an indication as to the basis of the type of matched data (name, ID, address, currency, country, web, etc.).
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Match Type
                                  type: string
                                matchedName:
                                  description: The name that matches the profile's primary name or one of its aliases.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Matched Name
                                  type: string
                                primaryName:
                                  description: The primary name of the matched profile.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Primary Name
                                  type: string
                                profileBirthPlaces:
                                  description: The data provided about birth places such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity was born.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity was born (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Birth Places
                                  type: array
                                profileGender:
                                  description: The gender of the matched profile, if known. Applies only for individuals.
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Gender
                                  type: string
                                profileId:
                                  description: The ID that is returned from the watchlist provider.
                                  maxLength: 100
                                  minLength: 1
                                  readOnly: true
                                  title: Profile ID
                                  type: string
                                profileIds:
                                  description: The list of all the IDs found in the profile that can potentially be matched with the IDs sent in the screened metadata.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile IDs
                                  type: array
                                profileLastUpdated:
                                  description: The timestamp of the profile's last update, in date-time format (RFC 3339).
                                  maxLength: 24
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Last Updated
                                  type: string
                                profilePlaces:
                                  description: The data provided about the location of the matched entity such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity is located.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity is located (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Places
                                  type: array
                                profileRelatedCountries:
                                  description: Other related countries of the matched profile (citizenships, incorporation, etc.).
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile Related Countries
                                  type: array
                                profileStatus:
                                  description: The status of the matched watchlist profile. The values indicate whether the record is active, inactive, deceased, or unknown.
                                  maxLength: 3
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Status
                                  type: string
                                profileType:
                                  description: The type of profile matched such as "individual", "entity", or "vessel".
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Type
                                  type: string
                                proximityScore:
                                  description: >-
                                    The proximity score with respect to a profile that is published by a watchlist.


                                    This attribute indicates how close a watchlist entry is to a sanctioned watchlist profile. Possible values include:


                                    100 - sanctioned profile


                                    80 - direct relationship with sanctioned profile


                                    50 - one relationship removed from a sanctioned profile


                                    0 - no relationship found


                                    null - undefined


                                    Note that all private list matches are returned as null (undefined).
                                  title: Proximity Score
                                  type: integer
                                  nullable: true
                                sanctions:
                                  description: The unique code of all the sanction lists in which this profile appears. These codes can be used in the "sanctions" preset field.
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Sanctions
                                  type: array
                                score:
                                  description: Indicates the confidence level of the match.
                                  title: Score
                                  type: integer
                                scoreScope:
                                  description: The list of matched metadata attributes such as DOB, city, country, gender, and ID.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Score Scope
                                  type: array
                                screened:
                                  description: >
                                    The text in the request in which the match was found. When screening names, this should be the same as the input string.

                                    When screening texts, this is a snippet containing the matched name.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Screened
                                  type: string
                                tags:
                                  description: >-
                                    Tags are used to indicate the type of list in which the record resides. It can also be used to indicate the entity type for the record.


                                    **List Types**:


                                    SAN = Sanctions Lists


                                    SIE = Special Interest Entity


                                    SIP = Special Interest Person


                                    PEP = Politically Exposed Person


                                    RCA = Relative or Close Associate


                                    SOC = State Owned Company


                                    OOL = Other Official Lists


                                    AM = Adverse Media


                                    BRD = Board Member


                                    **Entity Types**:


                                    LOC = Risk country


                                    VSL = Vessels


                                    AIR = Aircrafts


                                    For **Dow Jones Factiva**, see Description 1, Description 2, and Description 3.


                                    For **Refinitiv World-Check**, see Category and Sub-category.
                                  items:
                                    maxLength: 4
                                    minLength: 1
                                    type: string
                                  maxItems: 20
                                  title: Tags
                                  type: array
                              type: object
                            maxItems: 1000
                            title: Matched Profile
                            type: array
                            readOnly: true
                          messageReference:
                            description: The unique identifier that is generated by SAS Real-Time Watchlist Screening for a screening request. This value is populated in the screening response and is ignored on input.
                            maxLength: 36
                            minLength: 0
                            readOnly: true
                            title: Message Reference
                            type: string
                          statusCode:
                            description: >-
                              The status of a screening request at record level.
                               •  Success = screening successful
                               •  Warning = screening successful with warnings
                               •  Validation Failure = screening request failure
                               •  Failure = screening response failure
                            maxLength: 18
                            minLength: 7
                            readOnly: true
                            title: Status Code
                            type: string
                        readOnly: true
                        title: Screening Result
                        type: object
                      surname:
                        description: The surname of the entity being screened. If used with firstName, the two fields are combined to form the full name of the entity. The value must be at least 2 characters and not more than 100 characters.
                        maxLength: 100
                        minLength: 2
                        title: Surname
                        type: string
                      text:
                        description: The party information as unstructured data.  If the name field is specified, this field is ignored.
                        maxLength: 1000
                        title: Text
                        type: string
                    title: Ultimate Creditor
                    type: object
                  ultimateDebtor:
                    description: Ultimate debtor information.
                    properties:
                      account:
                        description: Incoming data from the customers that contain information that is related to a transaction.
                        properties:
                          currency:
                            description: The 3-digit alphabetic ISO currency code that is associated with the account.
                            maxLength: 3
                            minLength: 3
                            title: Currency
                            type: string
                          name:
                            description: The name of the account, as assigned by the account servicing institution. This provides an additional means of identification for the account.
                            maxLength: 200
                            title: Name
                            type: string
                          number:
                            description: The unique identifier that is associated with the account. This field is required and must be between 1 and 100 characters in length.
                            maxLength: 100
                            minLength: 1
                            title: Account Number
                            type: string
                          proxy:
                            description: An alternate assumed name for the identification of the account.
                            maxLength: 200
                            title: Proxy
                            type: string
                          type:
                            description: The type of the account (for example, savings, checking, and so on).
                            maxLength: 200
                            title: Account Type
                            type: string
                        required:
                          - number
                        title: Account
                        type: object
                      dateOfBirth:
                        description: >-
                          A supplied birthdate for the entity being screened. This object is used only when the type of entity being screened is "individual".

                          * If the birthtDt field is supplied, the birthDay, birthMonth, and birthYear fields are not used in the screening request.

                          * If the birthDt field is not supplied, an attempt is made to interpret the birthDay, birthMonth, and birthYear as a date, and use that in the screening request.

                          * If the birthDay or birthMonth are not specified, only the birthYear is used in the screening request.
                        properties:
                          birthDay:
                            description: The numeric birth day of the month for the entity being screened. This field can be used in combination with birthMonth and birthYear.
                            title: Day of Birth
                            type: integer
                          birthDt:
                            description: The birthdate, in ISO-8601 YYYY-MM-DD format, of the entity being screened. If provided, this field must be valid for the screening request to succeed.
                            maxLength: 10
                            title: Date of Birth
                            type: string
                          birthMonth:
                            description: The numeric birth month for the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthYear.
                            title: Month of Birth
                            type: integer
                          birthYear:
                            description: The birth year of the entity being screened. If provided, this field must be valid for the screening request to succeed. This field can be used in combination with birthDay and birthMonth.
                            title: Year of Birth
                            type: integer
                        title: Date of Birth
                        type: object
                      firstName:
                        description: The first name or names of the party.
                        maxLength: 100
                        minLength: 2
                        title: First Name
                        type: string
                      gender:
                        description: For an individual party, the gender of the person.  If not specified or an unexpected value is supplied, the record is processed using "other". Valid values are "male", "female", and "other".
                        maxLength: 10
                        title: Gender
                        type: string
                      identity:
                        description: The attributes that correspond to an entity's proof of identity.
                        items:
                          properties:
                            countryOfIssue:
                              description: The numeric ISO code of the country that is associated with the supplied form of identification for the entity.
                              title: Country of Issue (ISO)
                              type: integer
                            countryOfIssueCode:
                              description: The ISO 3166 alphabetic code of the country that is associated with the supplied form of identification for the entity. This can be an Alpha-2 or Alpha-3 code.
                              maxLength: 3
                              title: Country of Issue Code
                              type: string
                            dateOfExpiry:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Expiry
                              type: string
                            dateOfIssue:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Date of Issue
                              type: string
                            details:
                              description: Additional details for this form of identification.
                              maxLength: 100
                              title: Identity Details
                              type: string
                            issuedBy:
                              description: The entity that issued the identification.
                              maxLength: 36
                              title: Issued By
                              type: string
                            number:
                              description: The identifying number that is associated with the supplied form of identification for the entity. If a form of identity is provided, this field is required and must be valid for the screening request to succeed.
                              maxLength: 100
                              minLength: 1
                              title: Identity Number
                              type: string
                            type:
                              description: The type of identification that is supplied.
                              maxLength: 36
                              title: Identity Type
                              type: string
                            validFrom:
                              description: The date of issue for the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid From
                              type: string
                            validTo:
                              description: The expiration date of the supplied form of identification for the entity. Specify the value in ISO-8601 YYYY-MM-DD format.
                              maxLength: 10
                              title: Valid To
                              type: string
                          required:
                            - number
                          type: object
                        maxItems: 100
                        title: Identity
                        type: array
                      label:
                        description: An optional label that is used to help identify the party's role or map the party's role to the original transaction object.
                        maxLength: 200
                        title: Label
                        type: string
                      name:
                        description: >
                          The name of the entity being screened. If this field is specified,

                          the surname and firstName fields are ignored. The value must be at least 2 characters and not more than 220 characters. For individuals, the

                          value is interpreted as a comma-delimited list of "surname, first name".
                        maxLength: 220
                        minLength: 2
                        title: Name
                        type: string
                      placeOfBirth:
                        description: Incoming data from the customers that contain information related to the place of birth of a party that is involved in a transaction.
                        properties:
                          addressLines:
                            description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                            items:
                              maxLength: 500
                              type: string
                            title: Address Lines
                            type: array
                          city:
                            description: The city in which the party was born.
                            maxLength: 100
                            title: City
                            type: string
                          countryCode:
                            description: The alphabetic ISO 3166 code of the country in which the party was born. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                            maxLength: 3
                            minLength: 2
                            title: Country Code
                            type: string
                          postCode:
                            description: The postcode or ZIP code in which the party was born.
                            maxLength: 36
                            title: Address Postcode
                            type: string
                          state:
                            description: An optional code or name of the state in which the party was born.
                            maxLength: 100
                            title: State
                            type: string
                          text:
                            description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                            maxLength: 500
                            title: Text
                            type: string
                        required:
                          - countryCode
                        title: Place of Birth
                        type: object
                      postalAddress:
                        description: Incoming data from the customers that contain information related to the postal address of a party that is involved in a transaction.
                        items:
                          properties:
                            addressLines:
                              description: The street address of the party in an undifferentiated format. This can consist of multiple address components, such as street number, street name, building name, post office box number, and so on.
                              items:
                                maxLength: 500
                                type: string
                              title: Address Lines
                              type: array
                            city:
                              description: The city in which the party is located.
                              maxLength: 100
                              title: City
                              type: string
                            countryCode:
                              description: The alphabetic ISO 3166 code of the country in which the party is located. This can be an Alpha-2 or Alpha-3 code. If an address variable is provided, this field is required. If this code is invalid, the request for this entity results in an error.
                              maxLength: 3
                              minLength: 2
                              title: Country Code
                              type: string
                            postCode:
                              description: The postcode or ZIP code in which the party is located.
                              maxLength: 36
                              title: Address Postcode
                              type: string
                            state:
                              description: An optional code or name of the state in which the party is located.
                              maxLength: 100
                              title: State
                              type: string
                            text:
                              description: The address information as unstructured data. If a value is specified for this field, it takes precedence over the structured postalAddress fields. City and country pair values are extracted from this field.
                              maxLength: 500
                              title: Text
                              type: string
                          type: object
                        maxItems: 100
                        required:
                          - countryCode
                        title: Postal Address
                        type: array
                      screeningResult:
                        description: The result of a screening.
                        properties:
                          discardedHits:
                            description: The number of discarded hits against the entity that occurred during the screening request as a result of a screening exception.
                            title: Discarded Hits
                            type: integer
                            readOnly: true
                          hits:
                            description: The number of hits against the entity that occurred during the screening request.
                            title: Hits
                            type: integer
                            readOnly: true
                          maxScore:
                            title: Maximum Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.score of all of the matchedProfile records.
                            readOnly: true
                          primaryName:
                            title: Primary Name
                            type: string
                            description: For the screened entity, the matchedProfile.primaryName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          matchedName:
                            title: Matched name
                            type: string
                            description: For the screened entity, the matchedProfile.matchedName that is associated with the matchedProfile record that was used to determine screeningResult.maxScore.
                            readOnly: true
                            maxLength: 50
                          maxProximityScore:
                            title: Maximum Proximity Score
                            type: integer
                            description: For the screened entity, the highest matchProfile.proximityScore of all of the matchedProfile records.
                            readOnly: true
                          matchedProfile:
                            description: The outcome data that is received from the watchlist screening engine when a hit occurs. This data is utilized in the alert generation process.
                            items:
                              properties:
                                categories:
                                  description: The list of categories assigned to the profile that is returned from the watchlist provider.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Categories
                                  type: array
                                checksum:
                                  description: A hash of the entire watchlist profile. This enables you to verify the value against your alerts database to determine if it has changed.
                                  title: Checksum
                                  type: integer
                                coreChecksum:
                                  description: The checksum value that is associated with the subset of profile data that constitutes important information. This changes only when properties that are part of the screening logic are changed. This includes names, addresses, IDs, date of birth, sanctions, and status.
                                  title: Core Checksum
                                  type: integer
                                dateOfBirth:
                                  description: The data provided about dates of birth.
                                  items:
                                    properties:
                                      birthDay:
                                        description: The day of birth.
                                        title: Day of Birth
                                        type: integer
                                      birthDt:
                                        description: The date of birth in ISO-8601 YYYY-MM-DD format.
                                        maxLength: 10
                                        readOnly: true
                                        title: Date of Birth
                                        type: string
                                      birthMonth:
                                        description: The month of birth.
                                        title: Month of Birth
                                        type: integer
                                      birthYear:
                                        description: The year of birth.
                                        title: Year of Birth
                                        type: integer
                                    type: object
                                  maxItems: 100
                                  title: Date of Birth
                                  type: array
                                geoScore:
                                  title: Geo Score
                                  description: A value that indicates the geographic degree of correspondence between the screened entity and the matched profile. A value of 0 indicates that no evidence was found. A value above 50 indicates that at least one country reference was found. Additional references further increase the score.
                                  type: integer
                                  readOnly: true
                                geoClues:
                                  title: Geo Clues
                                  description: A list of geographic references to the countries in the matched profiles.
                                  type: array
                                  items:
                                    maxLength: 200
                                    minLength: 1
                                    type: string
                                  maxItems: 100
                                  readOnly: true
                                exceptionId:
                                  description: The ID that is returned against an exception that is found and applied to a match. This internal ID is returned by the watchlist screening engine.
                                  maxLength: 50
                                  readOnly: true
                                  title: Exception ID
                                  type: string
                                exceptionReference:
                                  title: Exception Reference
                                  description: The reference ID that is associated with the exception. This is an internal identifier that is assigned when the exception is created.
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationPath:
                                  title: Location Path
                                  description: In a complex screened object (text or transaction), an indication as to where a match was found. For entity screening, the value is always '/'. For payment screening, the value is a screened field (such as '/debtor/name').
                                  type: string
                                  minLength: 0
                                  maxLength: 200
                                  readOnly: true
                                locationFrom:
                                  title: Location From
                                  description: In screened text, the 0-based start position where the match was found.
                                  type: integer
                                  readOnly: true
                                locationTo:
                                  title: Location To
                                  description: In screened text, the 0-based end position where the match was found.
                                  type: integer
                                  readOnly: true
                                mediaAgeScore:
                                  title: Media Age Score
                                  description: A score that indicates the age of the adverse media articles that are found in a profile.
                                  type: integer
                                  readOnly: true
                                mediaQuantityScore:
                                  title: Media Quantity Score
                                  description: A score that indicates the number of adverse media articles that were found in a watchlist profile as compared to the average number of adverse media reports for all profiles.
                                  type: integer
                                  readOnly: true
                                level:
                                  description: The strength of the hit. This is based on the elements that have matched (such as name, city, country, gender, DOB, ID). If a match occurs only on name, the level is always "low". Otherwise, the level corresponds to the highest level assigned to the matched criteria as defined in the metadata policies. If the match was ignored as a result of a screening exception, the level value is set to "discarded".
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Level
                                  type: string
                                links:
                                  description: The links to the watchlist profile resource and, if applicable, the screening exception resource that are related to the matched profile.
                                  items:
                                    properties:
                                      href:
                                        description: The URL for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: HREF
                                        type: string
                                      itemType:
                                        description: If this is a link to a container, itemType is the media type or link type for the items in the container.
                                        maxLength: 200
                                        readOnly: true
                                        title: Item Type
                                        type: string
                                      method:
                                        description: The HTTP method for the link.
                                        maxLength: 6
                                        minLength: 1
                                        readOnly: true
                                        title: Method
                                        type: string
                                      rel:
                                        description: The relationship of the link to the resource.
                                        maxLength: 50
                                        minLength: 1
                                        readOnly: true
                                        title: Relation Type
                                        type: string
                                      responseItemType:
                                        description: The media type or link type of the items in the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Item Type
                                        type: string
                                      responseType:
                                        description: The media type or link type of the response body for a PUT, POST, or PATCH operation.
                                        maxLength: 200
                                        readOnly: true
                                        title: Response Type
                                        type: string
                                      title:
                                        description: The title for the link.
                                        maxLength: 100
                                        readOnly: true
                                        title: Title
                                        type: string
                                      type:
                                        description: The media type or link type for the link.
                                        maxLength: 200
                                        readOnly: true
                                        title: Media Type
                                        type: string
                                      uri:
                                        description: The relative URI for the link.
                                        maxLength: 500
                                        minLength: 1
                                        readOnly: true
                                        title: URI
                                        type: string
                                    type: object
                                  maxItems: 2
                                  required:
                                    - rel
                                  title: Links
                                  type: array
                                matchType:
                                  description: Provides an indication as to the basis of the type of matched data (name, ID, address, currency, country, web, etc.).
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Match Type
                                  type: string
                                matchedName:
                                  description: The name that matches the profile's primary name or one of its aliases.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Matched Name
                                  type: string
                                primaryName:
                                  description: The primary name of the matched profile.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Primary Name
                                  type: string
                                profileBirthPlaces:
                                  description: The data provided about birth places such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity was born.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity was born (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Birth Places
                                  type: array
                                profileGender:
                                  description: The gender of the matched profile, if known. Applies only for individuals.
                                  maxLength: 10
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Gender
                                  type: string
                                profileId:
                                  description: The ID that is returned from the watchlist provider.
                                  maxLength: 100
                                  minLength: 1
                                  readOnly: true
                                  title: Profile ID
                                  type: string
                                profileIds:
                                  description: The list of all the IDs found in the profile that can potentially be matched with the IDs sent in the screened metadata.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile IDs
                                  type: array
                                profileLastUpdated:
                                  description: The timestamp of the profile's last update, in date-time format (RFC 3339).
                                  maxLength: 24
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Last Updated
                                  type: string
                                profilePlaces:
                                  description: The data provided about the location of the matched entity such as city and country.
                                  items:
                                    properties:
                                      city:
                                        description: The city in which the matched entity is located.
                                        maxLength: 100
                                        readOnly: true
                                        title: City
                                        type: string
                                      countryCode:
                                        description: The country in which the matched entity is located (ISO2 code).
                                        maxLength: 2
                                        readOnly: true
                                        title: Country Code
                                        type: string
                                    type: object
                                  maxItems: 100
                                  title: Profile Places
                                  type: array
                                profileRelatedCountries:
                                  description: Other related countries of the matched profile (citizenships, incorporation, etc.).
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Profile Related Countries
                                  type: array
                                profileStatus:
                                  description: The status of the matched watchlist profile. The values indicate whether the record is active, inactive, deceased, or unknown.
                                  maxLength: 3
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Status
                                  type: string
                                profileType:
                                  description: The type of profile matched such as "individual", "entity", or "vessel".
                                  maxLength: 15
                                  minLength: 1
                                  readOnly: true
                                  title: Profile Type
                                  type: string
                                proximityScore:
                                  description: >-
                                    The proximity score with respect to a profile that is published by a watchlist.


                                    This attribute indicates how close a watchlist entry is to a sanctioned watchlist profile. Possible values include:


                                    100 - sanctioned profile


                                    80 - direct relationship with sanctioned profile


                                    50 - one relationship removed from a sanctioned profile


                                    0 - no relationship found


                                    null - undefined


                                    Note that all private list matches are returned as null (undefined).
                                  title: Proximity Score
                                  type: integer
                                  nullable: true
                                sanctions:
                                  description: The unique code of all the sanction lists in which this profile appears. These codes can be used in the "sanctions" preset field.
                                  items:
                                    maxLength: 20
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Sanctions
                                  type: array
                                score:
                                  description: Indicates the confidence level of the match.
                                  title: Score
                                  type: integer
                                scoreScope:
                                  description: The list of matched metadata attributes such as DOB, city, country, gender, and ID.
                                  items:
                                    maxLength: 50
                                    minLength: 1
                                    type: string
                                  maxItems: 50
                                  title: Score Scope
                                  type: array
                                screened:
                                  description: >
                                    The text in the request in which the match was found. When screening names, this should be the same as the input string.

                                    When screening texts, this is a snippet containing the matched name.
                                  maxLength: 50
                                  minLength: 1
                                  readOnly: true
                                  title: Screened
                                  type: string
                                tags:
                                  description: >-
                                    Tags are used to indicate the type of list in which the record resides. It can also be used to indicate the entity type for the record.


                                    **List Types**:


                                    SAN = Sanctions Lists


                                    SIE = Special Interest Entity


                                    SIP = Special Interest Person


                                    PEP = Politically Exposed Person


                                    RCA = Relative or Close Associate


                                    SOC = State Owned Company


                                    OOL = Other Official Lists


                                    AM = Adverse Media


                                    BRD = Board Member


                                    **Entity Types**:


                                    LOC = Risk country


                                    VSL = Vessels


                                    AIR = Aircrafts


                                    For **Dow Jones Factiva**, see Description 1, Description 2, and Description 3.


                                    For **Refinitiv World-Check**, see Category and Sub-category.
                                  items:
                                    maxLength: 4
                                    minLength: 1
                                    type: string
                                  maxItems: 20
                                  title: Tags
                                  type: array
                              type: object
                            maxItems: 1000
                            title: Matched Profile
                            type: array
                            readOnly: true
                          messageReference:
                            description: The unique identifier that is generated by SAS Real-Time Watchlist Screening for a screening request. This value is populated in the screening response and is ignored on input.
                            maxLength: 36
                            minLength: 0
                            readOnly: true
                            title: Message Reference
                            type: string
                          statusCode:
                            description: >-
                              The status of a screening request at the record level.
                               •  Success = screening successful
                               •  Warning = screening successful with warnings
                               •  Validation Failure = screening request failure
                               •  Failure = screening response failure
                            maxLength: 18
                            minLength: 7
                            readOnly: true
                            title: Status Code
                            type: string
                        readOnly: true
                        title: Screening Result
                        type: object
                      surname:
                        description: The surname of the entity being screened. If used with firstName, the two fields are combined to form the full name of the entity. The value must be at least 2 characters and not more than 100 characters.
                        maxLength: 100
                        minLength: 2
                        title: Surname
                        type: string
                      text:
                        description: The party information as unstructured data.  If the name field is specified, this field is ignored.
                        maxLength: 1000
                        title: Text
                        type: string
                    title: Ultimate Debtor
                    type: object
                type: object
                required:
                  - identifier
              maxItems: 1000
              minItems: 1
              title: Payment
              type: array
            screeningOptions:
              description: The options that are used to perform a screen against a list of payments.
              properties:
                chnPayment:
                  description: Enables you to override the default screening channel for payments.
                  maxLength: 50
                  title: Payment Channel
                  type: string
                exclusions:
                  description: >-
                    The party property types to be excluded from the payment screening process. Valid values are as follows:

                    • initiatingParty

                    • debtor

                    • debtorAgent

                    • ultimateDebtor

                    • creditor

                    • creditorAgent

                    • ultimateCreditor

                    • intermediaries
                  items:
                    maxLength: 100
                    type: string
                  maxItems: 10
                  title: Exclusions
                  type: array
                messageReference:
                  description: The unique identifier that is generated by SAS Real-Time Watchlist Screening for a screening request. This value is populated in the screening response and is ignored on input.
                  maxLength: 36
                  minLength: 0
                  readOnly: true
                  title: Message Reference
                  type: string
                projectReference:
                  description: A project reference that is attached to the screening request. It enables you to trace and report on special requests through the system. This variable is provided for informational purposes only.
                  maxLength: 100
                  title: Project Reference
                  type: string
                suppressAlertsFlg:
                  description: >-
                    Enables you to manage requests for tuning purposes. Valid values are as follows:
                     • true: Alerts are suppressed.
                     • false: Alerts are not suppressed.
                  title: Suppress Alerts Flag
                  type: boolean
                  default: false
                routingClassification:
                  title: Routing Classification
                  type: string
                  description: >
                    Enables you to override the default screening request routing classification. If no value is specified, a default routing classification is assigned: "batch" for Kafka messages and "real-time" for REST requests.
                  maxLength: 10
              title: Screening Options
              type: object
          type: object
          required:
            - payment
      title: Payment Screening
      type: object
    screeningResolution:
      title: Screening Resolution
      description: Screening Resolution is used to record the disposition of a screening hit.
      type: object
      required:
        - messageReference
        - profileId
        - resolutionName
        - modifiedBy
        - modifiedDttm
        - productivity
        - sendForReview
        - triggerException
        - matchFinalized
      properties:
        messageReference:
          type: string
          description: The unique identifier that is generated by SAS Real-Time Watchlist Screening for a screening request.
        profileId:
          type: string
          description: The ID of the watchlist profile.
        resolutionName:
          type: string
          description: The name of the resolution.
        productivity:
          type: string
          description: The productivity impact of the resolution.
        comment:
          type: string
          description: Any additional comments regarding the resolution.
        action:
          type: string
          description: The action taken as a result of the resolution.
        sendForReview:
          type: boolean
          description: Indicates whether the resolution should be sent for review.
        triggerException:
          type: boolean
          description: Indicates whether an exception should be triggered.
        modifiedBy:
          type: string
          description: The user who last modified the screening resolution.
        modifiedDttm:
          type: string
          description: The date and time when the screening resolution was last modified.
        reviewedBy:
          type: string
          description: The user who reviewed the screening resolution.
        reviewedDttm:
          type: string
          description: The date and time when the screening resolution was reviewed.
        matchFinalized:
          type: boolean
          description: Indicates whether the screening resolution is final.
    preset:
      title: Preset
      description: Presets are predefined options that control screening requests.
      type: object
      required:
        - name
        - options
      properties:
        id:
          type: string
          description: A unique identifier for the preset.
        name:
          type: string
          description: A unique name for the preset. The name is referenced in screening requests that use the preset. Names are automatically prefixed with the configured client reference for the deployment in order to ensure uniqueness across multiple environments (such as test and production).
        options:
          type: object
          required:
            - threshold
            - matching
            - geoScore
            - geoThreshold
            - lowQualityAliases
            - dobMatching
            - dobPrecision
            - dobPolicy
            - genderPolicy
            - idPolicy
            - idPrecision
            - cityProximity
            - cityPolicy
            - countryPolicy
            - charset
            - affinity
            - status
            - tweaks
          description: The set of options for this preset.
          properties:
            threshold:
              type: integer
              minimum: 50
              maximum: 100
              description: Specifies the name matching threshold. When the threshold value is between 50 and 84 matching is broader, and some hits are returned that would not be returned with a higher threshold.
            matching:
              type: string
              enum:
                - fuzzy
                - strict
                - balanced
                - broad
              description: >
                The matching technique:

                * **fuzzy**: is the default sensitivity in terms of the fuzzy logic capabilities and the affinity-specific strategies.

                * **strict**: applies a higher penalty for missing and mismatching words, while keeping the same level of fuzziness between words.

                * **balanced**: accepts a smaller set of misspells (doubled letters, letter inversions, mismatched vowels) and all the important words need to be matched, but the screening speed is extremely fast.

                * **broad**: is a Google-like search that (for example) raises hits when searching for a last name only. Note that the threshold is not used for this setting.
            recordType:
              type: string
              enum:
                - individual
                - entity
                - unknown
              description: By default, any screened records that are not assigned a record type are processed as type **unknown**. This option sets the default record type value for all records in a request that do not have a type assigned.
            geoScore:
              type: boolean
              description: When enabled, all the payment fields are searched for matches with the countries of any reported hit. As a result, a new score will be delivered in the response. This only applies to payment screening.
            geoThreshold:
              type: integer
              minimum: 0
              maximum: 100
              description: Defines a minimum threshold for the geoScore in the matches. If the computed geoScore is below this threshold, the matches are not reported. The geoScore option must be enabled for this option to affect payment screening.
            bicThreshold:
              type: integer
              minimum: 0
              maximum: 100
              description: Specifies the threshold to be used when screening expanded Business Identifier Codes (BICs).
            lowQualityAliases:
              type: string
              enum:
                - none
                - reclassified
              description: Specifies what type of lowQualityAlias should be included in the screening scope. Currently, only the reclassified aliases can be included.
            dobMatching:
              type: string
              enum:
                - year
                - perfect
              description: >
                The date of birth matching type: **perfect** matches the full date if available, **year** accepts the match if the year is matched.
            dobPrecision:
              type: integer
              minimum: 0
              maximum: 100
              description: >
                Date of birth matching precision: for year matching, specifies the accepted difference (in years). Note: when metaScore is set to **true**, and if the date of birth is within the defined range set by this parameter, the calculation of the score takes into account the ratio (actual year difference) / (dobPrecision). For example, a difference of 3 years between 2 dates with dobPrecision = 7 will score higher than if dobPrecision = 4 years for the same 3-year difference.
            dobPolicy:
              description: Date of birth policy.
              type: object
              required:
                - value
                - match
                - level
              properties:
                value:
                  type: string
                  enum:
                    - required
                    - optional
                    - expected
                  description: Specifies whether the metadata value should be defined in the watchlist record in order to accept a hit. With **expected**, a small penalty is applied to the final score in case of missing data while with **optional** the score is left untouched. *Note that when the metaScore is enabled, the default value is **expected** instead of **optional**.*
                match:
                  type: string
                  enum:
                    - required
                    - optional
                  description: Specifies whether the metadata value (when present), should match the value in the record (when present) in order to accept a hit. *Note that when the metaScore is enabled, the default value is **optional** instead of **required**.*
                level:
                  type: string
                  enum:
                    - low
                    - medium
                    - high
                  description: Specifies the level of importance that is assigned to the hit if the metadata value is found and matched.
            genderPolicy:
              description: Gender policy.
              type: object
              required:
                - value
                - match
                - level
              properties:
                value:
                  type: string
                  enum:
                    - required
                    - optional
                    - expected
                  description: Specifies whether the metadata value should be defined in the watchlist record in order to accept a hit. With **expected**, a small penalty is applied to the final score in case of missing data while with **optional** the score is left untouched. *Note that when the metaScore is enabled, the default value is **expected** instead of **optional**.*
                match:
                  type: string
                  enum:
                    - required
                    - optional
                  description: Specifies whether the metadata value (when present), should match the value in the record (when present) in order to accept a hit. *Note that when the metaScore is enabled, the default value is **optional** instead of **required**.*
                level:
                  type: string
                  enum:
                    - low
                    - medium
                    - high
                  description: Specifies the level of importance that is assigned to the hit if the metadata value is found and matched.
            idPolicy:
              description: The IDs policy.
              type: object
              required:
                - value
                - match
                - level
              properties:
                value:
                  type: string
                  enum:
                    - required
                    - optional
                    - expected
                  description: Specifies whether the metadata value should be defined in the watchlist record in order to accept a hit. With **expected**, a small penalty is applied to the final score in case of missing data while with **optional** the score is left untouched. *Note that when the metaScore is enabled, the default value is **expected** instead of **optional**.*
                match:
                  type: string
                  enum:
                    - required
                    - optional
                  description: Specifies whether the metadata value (when present), should match the value in the record (when present) in order to accept a hit. *Note that when the metaScore is enabled, the default value is **optional** instead of **required**.*
                level:
                  type: string
                  enum:
                    - low
                    - medium
                    - high
                  description: Specifies the level of importance that is assigned to the hit if the metadata value is found and matched.
            idPrecision:
              type: integer
              minimum: 3
              description: Specifies the required number of consecutive matching characters in two compared IDs in order to be considered potential matches.
            tags:
              type: array
              items:
                type: string
                enum:
                  - SAN
                  - PEP
                  - RCA
                  - SOC
                  - OOL
                  - AM
                  - BRD
                  - SIE
                  - SIP
                  - LOC
                  - VSL
                  - AIR
                  - PRV
                  - "!SAN"
                  - "!PEP"
                  - "!RCA"
                  - "!SOC"
                  - "!BRD"
                  - "!OOL"
                  - "!AM"
                  - "!SIE"
                  - "!SIP"
                  - "!LOC"
                  - "!VSL"
                  - "!AIR"
                  - "!PRV"
              description: Specifies the list of profile tag restrictions. To create an exclusion condition, prepend a tag with the "!" character. For sanction (or payment) screening, SAN and LOC are recommended.
            categories:
              type: array
              items:
                anyOf:
                  - type: string
                  - type: array
                    items:
                      type: string
              description: Specifies the list of profile categories to match. The possible values depend on the list vendor. The selection does match if at least one of the elements is matched (OR). If an element is an array, all the sub-elements must be matched (AND).
            sanctionCountries:
              type: array
              items:
                type: string
              description: Specifies the list of ISO 2 country codes that define which sanctions to search.
            sanctions:
              type: array
              items:
                type: string
              description: Specifies the list of codes that define which sanctions to search. The list of available codes depends on the watchlist provider.
            matchTypes:
              type: array
              items:
                type: string
              description: Specifies the list of match types to be included in the scope. To exclude a match type, prepend the "!" character to the match type. Refer to the party.screeningResult.matchedProfile.matchType field to view the available match type values.
            cityProximity:
              type: integer
              minimum: 0
              maximum: 1000
              description: Specifies the accepted distance (km) between two mismatched cities. Note that if metaScore is set to **true**, and if the location is within the defined range set by this parameter, the calculation of the score takes into account the ratio (actual distance) / (cityProximity). For example, a distance of 100 km between 2 locations with cityProximity = 1000 km scores higher than if cityProximity = 200 km for the same distance.
            cityPolicy:
              description: City policy in places.
              type: object
              required:
                - value
                - match
                - level
              properties:
                value:
                  type: string
                  enum:
                    - required
                    - optional
                    - expected
                  description: Specifies whether the metadata value should be defined in the watchlist record in order to accept a hit. With **expected**, a small penalty is applied to the final score in case of missing data while with **optional** the score is left untouched. *Note that when the metaScore is enabled, the default value is **expected** instead of **optional**.*
                match:
                  type: string
                  enum:
                    - required
                    - optional
                  description: Specifies whether the metadata value (when present) should match the value in the record (when present) in order to accept a hit. *Note that when the metaScore is enabled, the default value is **optional** instead of **required**.*
                level:
                  type: string
                  enum:
                    - low
                    - medium
                    - high
                  description: Specifies the level of importance that is assigned to the hit if the metadata value is found and matched.
            countryPolicy:
              description: Specifies the country policy that is applied to the "address" party field.
              type: object
              required:
                - value
                - match
                - level
              properties:
                value:
                  type: string
                  enum:
                    - required
                    - optional
                    - expected
                  description: Specifies whether the metadata value should be defined in the watchlist record in order to accept a hit. With **expected**, a small penalty is applied to the final score in case of missing data while with **optional** the score is left untouched. *Note that when the metaScore is enabled, the default value is **expected** instead of **optional**.*
                match:
                  type: string
                  enum:
                    - required
                    - optional
                  description: Specifies whether the metadata value (when present) should match the value in the record (when present) in order to accept a hit. *Note that when the metaScore is enabled, the default value is **optional** instead of **required**.*
                level:
                  type: string
                  enum:
                    - low
                    - medium
                    - high
                  description: Specifies the level of importance that is assigned to the hit if the metadata value is found and matched.
            charset:
              type: string
              enum:
                - latin
                - auto
              description: Specifies the character set that is used in queries. Set the value to **auto** if the original script names are being sent.
            affinity:
              type: string
              enum:
                - def
                - auto
                - trusted
                - cn
                - ar
                - kr
                - ru
              description: >
                The cultural affinity of the screened name. Depending on the specified (or detected) affinity, some specific matching rules might be used in order to improve the quality of the output.

                * **def** : specifies that the engine use the default affinity settings.

                * **auto** : specifies that the engine attempt to guess the cultural affinity of the screened name. Specifying at least a country in the **address** party field is recommended to increase the accuracy of the prediction.

                * **trusted** : specifies that the screening process use the affinity that is detected in the watchlist record. This is useful if the input data is incomplete or potentially incorrect.

                * The other values are ISO country codes that declare the name's cultural affinity. In case of a mismatch between the guessed affinity and the one of the potential match, the default rules are used instead.
            riskCountries:
              type: array
              items:
                type: string
              description: Specifies the list of ISO 2 risk country codes that define the countries against which to match your data. Potential matches are country and city names in your screened object (in **TEXT** mode) and **places** in the metadata.
            riskRegions:
              type: array
              items:
                type: string
              description: Specifies the the list of regions to identify in which main cities are detected. This includes regions in a private list. If the region exists in multiple countries, specify the country that is associated with the city by adding "/isoCode". Use the watchlist metadata "/collection/regions" endpoint to get the list of all region values.
            status:
              type: string
              enum:
                - any
                - active
                - inactive
                - deceased
              description: Specifies the minimum status of a matched record. If 'active', only the active profiles are matched. If 'inactive', active and inactive profiles are matched. If 'deceased' only deceased profiles are matched.
            inactiveDays:
              type: integer
              description: Specifies the number of days since this record was flagged as inactive (PEP or RCA). This is available only in some watchlists.
            pepLevel:
              type: string
              enum:
                - intl
                - state
                - regional
                - local
              description: For PEPs, the minimum level of responsibility.
            tweaks:
              type: object
              required:
                - detectTitle
                - detectBicCodes
                - useTextPlaces
                - surnameAbbreviations
                - perfectSmallNames
                - bidirectionalMatching
                - deepIndexSearch
                - lowQualityNicknames
                - partialIndividualNames
                - partialIndividualNamePatterns
                - partialEntityNames
                - longAbbreviations
                - minTextMatchLength
                - globalLegalForms
              description: Specifies the advanced screen options.
              properties:
                detectTitle:
                  type: boolean
                  description: When enabled, any title in the passed name (Mr, Dr, and so on) is identified. A title has a very low weight in the final score.
                detectBicCodes:
                  type: boolean
                  description: When enabled, any Swift BIC-8 or BIC-11 identifier in the names and texts is detected, expanded, and screened.
                useTextPlaces:
                  type: boolean
                  description: When enabled, uses the identified city/country pairs in a screened **text**, and automatically adds them as places in the screening context. This enables the metaScore for this request only.
                surnameAbbreviations:
                  type: boolean
                  description: When enabled, abbreviations are accepted in the main surname words. For example, Saddam H. will match Saddam Hussein. It is recommended that you turn this on only for ad hoc searches.
                perfectSmallNames:
                  description: Configures the matching policy for names composed of a single small word.
                  oneOf:
                    - type: boolean
                      description: When enabled, any match with a name composed by a single small word (<= 4 letters) must be perfect.
                    - type: integer
                      description: Specifies the maximum length of small words for which a perfect match is required.
                      minimum: 0
                      maximum: 10
                bidirectionalMatching:
                  type: boolean
                  description: When enabled, word-level matching is performed from both the left and right sides. This can help to catch matches where the beginning of the word has 2 or more unexpected letters.
                deepIndexSearch:
                  type: boolean
                  description: >
                    When names are screened, a word index is built for the submitted request and list profiles are considered candidates (potential matches), if they contain indexed words.

                    Noise words, legal forms, and other lower weighted words are generally not indexed. Using this tweak forces the indexing of all words and considers any list profile

                    that contains at least one of the words, even if the matching word is noisy. Note that enabling this tweak can negatively impact performance.
                lowQualityNicknames:
                  type: boolean
                  description: Specifies the system contains data tables with nicknames (for example, Anthony/Tony). When this tweak is enabled, this table is extended with more variations such as translations or language-specific name alternatives (for example, John/Juan, Viktor/Vitya).
                partialIndividualNames:
                  type: string
                  description: >
                    Configures the partial matching policy for individual names.

                    * NONE:  Any unmatched word in the request or in the list profile lowers the score, based on its nature. For example, common words like GROUP or a legal form have a lot less weight.

                    * REQUEST: If all the words in the list profile are matched, any unmatched word in the request only slightly impacts the score.

                    * PROFILE: If all the words in the request are matched, any unmatched word in the profile only slightly impacts the score.

                    * BOTH: Assuming that the name is fully matched, any other word in the request or the profile only slightly impacts the score.


                    Note that, by default, at least one word in the surnames, except particles such as AL, BIN, etc., and one word in the first and middle names can be matched. Other patterns can be configured in the "partialIndividualNamePatterns" field.
                  enum:
                    - NONE
                    - REQUEST
                    - PROFILE
                    - BOTH
                partialIndividualNamePatterns:
                  type: array
                  items:
                    type: string
                  description: Specifies the list of patterns for the partial individual name matching. One pattern is in the form "x,y" where x is the minimum amount of matched words in the surnames group and y is the minimum amount of matched words in the first names group. Note that particles are excluded.
                partialEntityNames:
                  type: string
                  description: >
                    Configures the partial matching policy for entity names.

                    * NONE:  Any unmatched word in the request or in the list profile lowers the score, based on its nature. For example, common words like GROUP or a legal form have a lot less weight.

                    * REQUEST: If all the words in the list profile are matched, any unmatched word in the request only slightly impacts the score.

                    * PROFILE: If all the words in the request are matched, any unmatched word in the profile only slightly impacts the score.

                    * BOTH: Assuming that the name is fully matched, any other word in the request or the profile only slightly impacts the score.
                  enum:
                    - NONE
                    - REQUEST
                    - PROFILE
                    - BOTH
                longAbbreviations:
                  type: boolean
                  description: Allows a word (>3 letters) to be considered as a truncation of a much longer word (>= 6 letters). For example, 'Intern' would be considered an abbreviation of 'International'.
                minTextMatchLength:
                  type: integer
                  minimum: 0
                  maximum: 5
                  description: Specifies the minimum length of matches found in texts, if only 1 word is matching.
                globalLegalForms:
                  type: boolean
                  description: Looks for legal form words in the screened entity name regardless of the locations specified in the "address" party field. This includes searching in languages that do not match the country of incorporation of the entity.
            exclusions:
              type: array
              items:
                type: string
              description: >
                An array of (root level) JetFlow property names that should **not** be screened. By default, this includes paymentId, amount, paymentType,

                direction, transactionId, transactionType. Note that paymentId and paymentType are obsolete and have been replaced by transactionId and transactionType respectively.
            fieldPresets:
              type: object
              description: By default, the top-level options and presets are used. This object can overwrite the default and specify which preset to use with which field.
              additionalProperties:
                type: string
                description: Specifies the name of the preset to apply when screening this field.
              example:
                creditor: san
                debtor: pep
            metaScore:
              type: boolean
              readOnly: true
              default: true
              description: When enabled, the final score takes into account any matched metadata, assuming that the requested precision is reached. For example, if the DOB precision is set to 5 years, the closer they match, the higher the score; but the hit is discarded if the DOB difference is > 5 years.  This value is provided as a default, and is ignored on input.
            detectStripping:
              type: boolean
              readOnly: true
              default: false
              description: When enabled, this transaction is included in a stripping detection process and returns a status if an attempt to resubmit a similar transaction without the reported hit(s) is identified.  This value is provided as a default, and is ignored on input.
            detectDuplicates:
              type: boolean
              readOnly: true
              default: false
              description: When enabled, this transaction is included in a duplicate detection process and returns a status if the exact same transaction has been seen before. This value is provided as a default, and is ignored on input.
        creationTimeStamp:
          type: string
          description: Specifies the date and time that this object was created, in the format of YYYY-MM-DDThh:mm:ss.sssZ. This value is ignored on input.
          format: date-time
          readOnly: true
        modifiedTimeStamp:
          type: string
          description: Specifies the date and time that this object was last modified, in the format of YYYY-MM-DDThh:mm:ss.sssZ. This value is ignored on input.
          format: date-time
          readOnly: true
        version:
          type: integer
          description: Specifies the version number of the media type.
        links:
          type: array
          description: Specifies the links that apply to the object. This value is ignored on input.
          items:
            title: Link
            type: object
            description: A link to a related operation or resource.
            required:
              - rel
            properties:
              method:
                type: string
                description: The HTTP method for the link.
              rel:
                type: string
                description: The relationship of the link to the resource.
              uri:
                type: string
                description: The relative URI for the link.
              href:
                type: string
                description: The URL for the link.
              title:
                type: string
                description: The title for the link.
              type:
                type: string
                description: The media type or link type for the link.
              itemType:
                type: string
                description: If this is a link to a container, `itemType` is the media type or link type for the items in the container.
              responseType:
                type: string
                description: The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
              responseItemType:
                type: string
                description: The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
          readOnly: true
    channel:
      title: Channel
      description: A channel is a type of preset that matches screened records to a specific preset based on the tags found in screened records.
      type: object
      required:
        - name
        - options
      properties:
        id:
          type: string
          description: Specifies a unique identifier for the channel.
        name:
          type: string
          description: A unique name for the channel. The name is referenced in screening requests that use the channel. Names are automatically prefixed with the configured client reference for the deployment in order to ensure uniqueness across multiple environments (such as test and production).
        options:
          type: object
          description: Specifies the set of options for this preset.
          required:
            - tags
            - tagPresets
          properties:
            tagPresets:
              type: array
              description: >
                The ordered mapping between a tag found in the potentially matched watchlist record and a preset to use. The first applicable mapping is used. There

                must be at least one mapping.
              items:
                type: object
                required:
                  - tag
                  - preset
                properties:
                  tag:
                    type: string
                    description: Specifies the tag to match in the watchlist record.
                  preset:
                    type: string
                    description: Specifies the name of the preset to apply. Names are automatically prefixed with the configured client reference for the deployment in order to ensure uniqueness across multiple environments (such as test and production).
            tags:
              type: array
              items:
                type: string
                enum:
                  - SAN
                  - PEP
                  - RCA
                  - SOC
                  - OOL
                  - AM
                  - BRD
                  - SIE
                  - SIP
                  - LOC
                  - VSL
                  - AIR
                  - PRV
                  - "!SAN"
                  - "!PEP"
                  - "!RCA"
                  - "!SOC"
                  - "!BRD"
                  - "!OOL"
                  - "!AM"
                  - "!SIE"
                  - "!SIP"
                  - "!LOC"
                  - "!VSL"
                  - "!AIR"
                  - "!PRV"
              description: Specifies the list of profile tag restrictions. To create an exclusion condition, prepend a tag with the "!" character. For sanction (or payment) screening, SAN and LOC are recommended.
        creationTimeStamp:
          type: string
          description: Specifies the date and time that this object was created, in the format of YYYY-MM-DDThh:mm:ss.sssZ. This value is ignored on input.
          format: date-time
          readOnly: true
        modifiedTimeStamp:
          type: string
          description: Specifies the date and time that this object was last modified, in the format of YYYY-MM-DDThh:mm:ss.sssZ. This value is ignored on input.
          format: date-time
          readOnly: true
        version:
          type: integer
          description: Specifies the version number of the media type.
        links:
          type: array
          description: Specifies the links that apply to the object. This value is ignored on input.
          items:
            $ref: "#/components/schemas/preset/properties/links/items"
          readOnly: true
    presetCollection:
      title: Preset Collection
      description: A collection of presets and channels.
      allOf:
        - title: Base Collection
          description: This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)
          properties:
            name:
              type: string
              description: The name of the collection.
            start:
              type: integer
              description: The zero-based index of the first item in the collection.
              format: int64
            limit:
              type: integer
              description: The number of items that were requested for the collection.
            count:
              type: integer
              description: If populated indicates the number of items in the collection.
              format: int64
            accept:
              type: string
              description: A space-delimited list of media types from which an `Accept` header may be constructed.
            links:
              type: array
              description: The links that apply to the collection.
              items:
                $ref: "#/components/schemas/preset/properties/links/items"
            version:
              type: integer
              description: The version number of the collection representation. This representation is version 2.
        - type: object
          required:
            - items
          properties:
            items:
              type: array
              description: Specifies the list of available presets and channels.
              items:
                anyOf:
                  - $ref: "#/components/schemas/preset"
                  - $ref: "#/components/schemas/channel"
    profileException:
      title: Profile Exception
      description: >
        A profile exception identifies a profile that does not generate alerts for a specific entity during the

        screening process. A profile exception applies if both the party identifier and the screening result

        profile ID match the values that are specified for the exception. When these fields match, the screening

        result hit is classified as "discarded".
      type: object
      required:
        - identifier
        - profileId
      properties:
        id:
          type: string
          description: The internal exception ID that is used to refer to the exception. This value is ignored on input.
          readOnly: true
        identifier:
          type: string
          description: A user provided identifier that corresponds to the "identifier" field in a party record used for screening.
        profileId:
          type: string
          description: The profile ID of the watchlist record that is attached to this exception.
        status:
          readOnly: true
          type: string
          description: The status of the exception. This value is ignored on input.
        creationTimeStamp:
          type: string
          description: The date and time this object was created, in the format of YYYY-MM-DDThh:mm:ss.sssZ. This value is ignored on input.
          format: date-time
          readOnly: true
        modifiedTimeStamp:
          type: string
          description: The date and time this object was last modified, in the format of YYYY-MM-DDThh:mm:ss.sssZ. This value is ignored on input.
          format: date-time
          readOnly: true
        version:
          type: integer
          description: The version number of the media type. This value is ignored on input.
          readOnly: true
        links:
          type: array
          description: The links that apply to the object. This value is ignored on input.
          items:
            $ref: "#/components/schemas/preset/properties/links/items"
          readOnly: true
    conditionalException:
      title: Conditional Exception
      description: >
        A conditional exception identifies conditions that do not generate alerts for a screening request during

        the screening process. A conditional exception applies if the data in a screening request satisfy the conditions

        specified by the conditional exception. When these conditions are met, the screening result hit is classified as "discarded".
      type: object
      required:
        - expirationType
      properties:
        id:
          type: string
          description: The internal exception ID that is used to refer to the exception. This value is ignored on input.
          readOnly: true
        status:
          readOnly: true
          type: string
          description: The status of the exception. This value is ignored on input.
        profileId:
          type: string
          description: The profile ID of the watchlist record that is attached to this exception. This value is immutable after creation.
        match:
          type: string
          description: >
            The name (or alias) of the watchlist record that should be accepted. When empty, any match with the given profile is managed by this exception.

            This data is not retained. Instead, a hash is computed and returned in the matchHash field. This value is immutable after creation. If a value is provided, a valid profileId value is required.
          writeOnly: true
        matchHash:
          type: integer
          description: The internal hash of the matched name. A hash value is generated because the actual value is not retained.
          readOnly: true
        source:
          type: string
          description: >
            The exact string for which a match is triggered. The exception is active only if the same source is screened again. The matching string is not case sensitive.

            When empty, any string that triggers the specified match is managed by this exception. This data is not retained. Instead, a hash is computed and returned in the sourceHash field. This value is immutable after creation. If a value is provided, a valid profileId value is required.
          writeOnly: true
        sourceHash:
          type: integer
          description: >
            The internal hash of the source data. A hash value is generated because the actual value is not retained.
          readOnly: true
        expirationType:
          type: string
          description: >-
            Determines the condition in which this exception should be invalidated:

             • NEVER: The exception never expires.

             • DATE: When the scheduled date occurs.

             • PROFILE: When the profile changes in the watchlist. If this value is provided, a valid profileId value is required.

             • CORE_PROFILE: When any important profile information has changed in the watchlist. Important profile information includes all the properties that are part of the screening logic. This includes names, addresses, IDs, dates of birth, sanctions, status, etc. If this value is provided, a valid profileId value is required.
          enum:
            - NEVER
            - DATE
            - PROFILE
            - CORE_PROFILE
        expirationDate:
          type: string
          description: If the expirationType is set to DATE, specifies the expiration date of the exception. This is required if expirationType=DATE.
        profileChecksum:
          type: integer
          description: The profile checksum (as provided in the screening results) to be used if the expirationType is set to PROFILE. This is required if expirationType=PROFILE.
        coreChecksum:
          type: integer
          description: The core profile checksum (as provided in the screening results) to be used if the expirationType is set to CORE_PROFILE. This is required if expirationType=CORE_PROFILE.
        prefix:
          type: string
          description: Specifies the text to match that precedes the exact text (source) in order to apply this exception. This is optional. If a value is provided, a valid profileId value is required.
        suffix:
          type: string
          description: Specifies the text to match that follows the exact text (source) in order to apply this exception. This is optional. If a value is provided, a valid profileId value is required.
        conditions:
          type: array
          description: Specifies additional restrictions on the request or found match for this exception to be applicable.
          maxItems: 20
          items:
            type: object
            required:
              - path
              - operator
              - value
            properties:
              path:
                type: string
                description: Specifies the path to a SAS Real-Time Watchlist Screening message schema field. The extracted field value evaluates against the provided condition value. The valid paths are listed as 'enum' values.
                enum:
                  - /matchedProfile/categories
                  - /matchedProfile/checksum
                  - /matchedProfile/coreChecksum
                  - /matchedProfile/dateOfBirth/birthDay
                  - /matchedProfile/dateOfBirth/birthMonth
                  - /matchedProfile/dateOfBirth/birthYear
                  - /matchedProfile/level
                  - /matchedProfile/locationPath
                  - /matchedProfile/matchType
                  - /matchedProfile/matchedName
                  - /matchedProfile/primaryName
                  - /matchedProfile/profileBirthPlaces/city
                  - /matchedProfile/profileBirthPlaces/countryCode
                  - /matchedProfile/profileGender
                  - /matchedProfile/profileId
                  - /matchedProfile/profileIds
                  - /matchedProfile/profileLastUpdated
                  - /matchedProfile/profilePlaces/city
                  - /matchedProfile/profilePlaces/countryCode
                  - /matchedProfile/profileStatus
                  - /matchedProfile/profileType
                  - /matchedProfile/sanctions
                  - /matchedProfile/score
                  - /matchedProfile/scoreScope
                  - /matchedProfile/screened
                  - /matchedProfile/tags
                  - /party/address/category
                  - /party/address/city
                  - /party/address/countryCode
                  - /party/address/postcode
                  - /party/dateOfBirth/birthDt
                  - /party/gender
                  - /party/identifier
                  - /party/identity/number
                  - /payment/amount
                  - /payment/currency
                  - /payment/purpose
                  - /payment/transactionId
                  - /payment/transactionType
              operator:
                type: string
                description: the comparison operator to apply on the path.
                enum:
                  - =
                  - "!="
                  - ">"
                  - ">="
                  - <
                  - <=
                  - between
                  - contains
              value:
                description: >
                  The string (or a list of possible strings) to match with the extracted path field. This value is considered to be a regular expression

                  if it starts with the special character ~ (for example, ~[0-9]{1,2}). This value is replaced with the content of a path (extracted value) when

                  wrapped in ${} (for example, ${/party/identifier}).
                oneOf:
                  - type: string
                  - type: array
                    minItems: 1
                    items:
                      type: string
        creationTimeStamp:
          type: string
          description: The date and time that this object was created, in the format of YYYY-MM-DDThh:mm:ss.sssZ. This value is ignored on input.
          format: date-time
          readOnly: true
        modifiedTimeStamp:
          type: string
          description: The date and time that this object was last modified, in the format of YYYY-MM-DDThh:mm:ss.sssZ. This value is ignored on input.
          format: date-time
          readOnly: true
        version:
          type: integer
          description: The version number of the media type. This value is ignored on input.
          readOnly: true
        links:
          type: array
          description: The links that apply to the object. This value is ignored on input.
          items:
            $ref: "#/components/schemas/preset/properties/links/items"
          readOnly: true
    screeningExceptionCollection:
      title: Screening Exception Collection
      description: A collection of screening exceptions.
      allOf:
        - $ref: "#/components/schemas/presetCollection/allOf/0"
        - type: object
          required:
            - items
          properties:
            items:
              type: array
              description: The list of available screening exceptions.
              items:
                anyOf:
                  - $ref: "#/components/schemas/profileException"
                  - $ref: "#/components/schemas/conditionalException"
    watchlistCategories:
      title: Watchlist Categories
      description: Metadata that contains information about a watchlist's categories.
      type: object
      properties:
        watchlist:
          type: string
          description: The name of the watchlist.
        captureDt:
          type: string
          description: The date on which the watchlist was captured.
        data:
          type: array
          description: The list of watchlist categories.
          items:
            type: object
            properties:
              listId:
                type: string
                description: The ID of the list the sanction belongs to.
              category:
                type: string
                description: The category label of the list.
        links:
          type: array
          description: The links that apply to the object. The value is ignored on input.
          items:
            $ref: "#/components/schemas/preset/properties/links/items"
          readOnly: true
    watchlistCategoriesCollection:
      title: Watchlist Categories Collection
      description: A collection of watchlist categories.
      allOf:
        - $ref: "#/components/schemas/presetCollection/allOf/0"
        - type: object
          required:
            - items
          properties:
            items:
              type: array
              items:
                $ref: "#/components/schemas/watchlistCategories"
    watchlistSanctionCodes:
      title: Watchlist Sanction Codes
      description: Metadata that contains information about a watchlist's sanction codes.
      type: object
      properties:
        watchlist:
          type: string
          description: The name of the watchlist.
        captureDt:
          type: string
          description: The date on which the watchlist was captured.
        data:
          type: array
          description: The list of watchlist sanction codes.
          items:
            type: object
            properties:
              code:
                type: string
                description: The sanction code.
              country:
                type: string
                description: The ISO country code.
              labels:
                type: array
                description: The list of sanction names.
                items:
                  type: string
              listId:
                type: string
                description: The ID of the list the sanction belongs to.
        links:
          type: array
          description: The links that apply to the object. The value is ignored on input.
          items:
            $ref: "#/components/schemas/preset/properties/links/items"
          readOnly: true
    watchlistSanctionCodesCollection:
      title: Watchlist Sanction Codes Collection
      description: A collection of watchlist sanction codes.
      allOf:
        - $ref: "#/components/schemas/presetCollection/allOf/0"
        - type: object
          required:
            - items
          properties:
            items:
              type: array
              items:
                $ref: "#/components/schemas/watchlistSanctionCodes"
    watchlistScreeningStatsCollection:
      title: Watchlist Screening Statistics Collection
      description: A collection of watchlist screening statistics.
      allOf:
        - $ref: "#/components/schemas/presetCollection/allOf/0"
        - type: object
          required:
            - items
          properties:
            items:
              type: array
              description: The list of statistics.
              items:
                title: Watchlist Screening Statistics
                description: Watchlist screening statistics contain information about the number of screening requests made during the current month.
                type: object
                properties:
                  collection:
                    type: string
                    description: The name of the watchlist collection.
                  date:
                    type: string
                    description: The date of the screening statistics.
                  counters:
                    type: object
                    description: The total number of requests made per product.
                    properties:
                      entityScreeningRequests:
                        type: integer
                        description: The total number of entity screening requests.
                      transactionScreeningRequests:
                        type: integer
                        description: The total number of transaction screening requests.
    watchlistScreeningSettings:
      title: Watchlist Screening Settings
      description: Watchlist screening settings contain information about the configuration of the watchlist screening service.
      type: object
      properties:
        clientReference:
          type: string
          description: The client reference for the watchlist screening service.
        version:
          type: integer
          description: The version of the watchlist screening settings.
