LSEG World-Check One Zero Footprint Screening API

openapi: 3.2.0
info:
  title: London Stock Exchange Group LSEG World-Check One Api-Info Zfs API
  description: 'The World-Check One API enables developers to integrate the next generation of LSEG screening capabilities into existing workflows and internal systems (such as CRMs) in order to help streamline the processes for on-boarding, KYC and third party due diligence.

    The API provides, among other features:

    - The ability to screen entity names, with or without secondary fields such as date of birth for individuals. These names are called “cases” within the World-Check One system.

    - The ability to retrieve results of the screening process from the World-Check database

    - The ability to flag cases for Ongoing Screening, and retrieve the World-Check results from the Ongoing Screening process.

    - The ability to submit request for reports.

    - The ability to fetch the status of the report requests and download the completed reports.

    > © 2018 - 2023 LSEG. All rights reserved. Republication or redistribution of LSEG content, including by framing or similar means, is prohibited without the prior written consent of LSEG. ''LSEG'' and the LSEG logo are registered trademarks and trademarks of LSEG and its affiliated companies.

    '
  version: 2.61.0
  termsOfService: https://www.lseg.com/en/risk-intelligence/screening-solutions/world-check-kyc-screening/one-kyc-verification
  contact:
    name: LSEG World-Check One API Q&A
    url: https://community.developers.refinitiv.com/index.html
    email: c3r.api1@lseg.com
  license:
    name: Commercial
    url: https://www.lseg.com/en/risk-intelligence/screening-solutions/world-check-kyc-screening/one-kyc-verification
servers:
- url: https://api-worldcheck.refinitiv.com/v2
tags:
- name: Zfs
  description: Operations for the ZFS domain.
paths:
  /groups:
    get:
      operationId: getGroups
      tags:
      - Zfs
      summary: London Stock Exchange Group Get all the top-level groups with their immediate descendants
      description: Get all the top-level groups with their immediate descendants
      parameters:
      - name: Authorization
        description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details)
        in: header
        required: true
        schema:
          type: string
      - name: Date
        description: The date and time at which the message was originated in 'RFC 1123' format
        in: header
        required: true
        schema:
          type: string
      responses:
        200:
          description: A list of all top-level groups containing their immediate descendants
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Group'
            application/octet-stream:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Group'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        404:
          $ref: '#/components/responses/CannotReturnResponse'
        415:
          $ref: '#/components/responses/UnsupportedMediaType'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/UnexpectedError'
  /groups/{groupId}:
    get:
      operationId: getGroupById
      tags:
      - Zfs
      summary: London Stock Exchange Group Get a specified group including its immediate descendants
      description: Get a specified group including its immediate descendants
      parameters:
      - name: Authorization
        description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details)
        in: header
        required: true
        schema:
          type: string
      - name: Date
        description: The date and time at which the message was originated in 'RFC 1123' format
        in: header
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        required: true
        description: Group ID under which we wish to retrieve children groups
        schema:
          type: string
      responses:
        200:
          description: A specified group including its immediate descendants
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Group'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        404:
          $ref: '#/components/responses/CannotReturnResponse'
        415:
          $ref: '#/components/responses/UnsupportedMediaType'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/UnexpectedError'
  /groups/{groupId}/caseTemplate:
    get:
      operationId: getCaseTemplateForGroup
      tags:
      - Zfs
      summary: London Stock Exchange Group Get the CaseTemplate for the given Group
      description: "Get the CaseTemplate for the given Group, used for constructing a Case\n\n**Available secondary fields:**\n<details>\n  <summary>Click here to expand</summary>\n\n  | Type ID   | NAME                    | VALUE                     |\n  |--|-||\n  | SFCT_1    | GENDER                  | MALE, FEMALE, UNSPECIFIED |\n  | SFCT_2    | DATE OF BIRTH           | DATE                      |\n  | SFCT_3    | COUNTRY LOCATION        | COUNTRY CODE              |\n  | SFCT_4    | PLACE OF BIRTH          | COUNTRY CODE              |\n  | SFCT_5    | NATIONALITY             | COUNTRY CODE              |\n  | SFCT_6    | REGISTERED COUNTRY      | COUNTRY CODE              |\n  | SFCT_7    | IMO NUMBER              | TEXT                      |\n  | SFCT_8    | PASSPORT GIVEN NAMES    | TEXT                      |\n  | SFCT_9    | PASSPORT LAST NAME      | TEXT                      |\n  | SFCT_10   | PASSPORT GENDER         | MALE, FEMALE, UNSPECIFIED |\n  | SFCT_11   | PASSPORT ISSUING STATE  | STATE CODE                |\n  | SFCT_12   | PASSPORT NATIONALITY    | STATE CODE                |\n  | SFCT_13   | PASSPORT DATE OF BIRTH  | DATE                      |\n  | SFCT_14   | PASSPORT DOCUMENT TYPE  | PASSPORT, ID1, ID2        |\n  | SFCT_15   | PASSPORT ID NUMBER      | TEXT                      |\n  | SFCT_16   | PASSPORT DATE OF EXPIRY | DATE                      |\n  | SFCT_191  | DOCUMENT ID             | TEXT                      |\n  | SFCT_192  | DOCUMENT ID COUNTRY     | COUNTRY CODE              |\n  | SFCT_193  | DOCUMENT ID TYPE        | TEXT                      |\n\n</details>\n"
      parameters:
      - name: Authorization
        description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details)
        in: header
        required: true
        schema:
          type: string
      - name: Date
        description: The date and time at which the message was originated in 'RFC 1123' format
        in: header
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        required: true
        description: Group ID under which we wish to manage Cases and perform screening
        schema:
          type: string
      responses:
        200:
          description: The CaseTemplate for the given Group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaseTemplateResponse'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/CaseTemplateResponse'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        404:
          $ref: '#/components/responses/CannotReturnResponse'
        415:
          $ref: '#/components/responses/UnsupportedMediaType'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/UnexpectedError'
  /cases/screeningRequest:
    post:
      operationId: screen
      tags:
      - Zfs
      summary: London Stock Exchange Group Perform synchronous screening for a new case
      description: "Perform synchronous screening for a new case.\n\nThis endpoint can perform a synchronous screening for a set of valid case details and, if provided,\nset the ongoing screening (OGS) state for the given provider types. The supported provider types for setting\nthe OGS state are WATCHLIST and MEDIA_CHECK. They both can be set to either INITIAL (OGS disabled) or ONGOING\n(OGS enabled) state. You cannot set the OGS state when using Zero Footprint Screening (ZFS) groups.\n\nThe returned result collection contains the regular case result details plus identity documents and important events.\nZFS is enabled by specifying a ZFS group id in the body and is available for dedicated Zero-footprint API customers\nor Regular WC1 API customers using ZFS-specific groups.\n\nThe response may contain Special Interest Categories (SIC) records that depends on the user subscription type.\nThis helps in SIC risk analysis:\n\n  - if a user has subscription type is Premium or Premium Plus, the keywords for SIC subcategories provided\n  in the \"sources\" field and full value of SIC keywords code in the \"categories\" field;\n\n  -  if a user has a Standard subscription type then the \"categories\" field will not contain SIC keywords;\n\n  -  the above behavior is the same for ZFS.\n\nThe example response body includes SIC with Premium or Premium Plus user subscription:\n\n```\n    {\n      \"sources\":[\n        \"b_trwc_M:1TQ\",\n        \"b_trwc_4\"\n      ],\n      \"categories\":[\n        \"Special Interest Categories\",\n        \"Other Bodies\"\n      ]\n    }\n```\n\n**Note:** The maximum number of World-Check screenings (including initial, rescreening, and ZFP ones)\n          that a client can perform in an hour is limited.\n\nWhen using the API care should be taken when using operator words even when combined with an apostrophe,\nfor example the below combinations will cause an error 403 to be returned:\n\n- String ‘AND (String)\n- String ‘OR (String)\n- String ‘AND NOT (String)\n- String ‘OR NOT (String)\n- String ‘AND AS (String)\n- String ‘OR AS (String)\n\n**Info about available secondary fields can be found [here](#tag/groups/operation/getCaseTemplateForGroup).**\n"
      parameters:
      - name: Authorization
        description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details)
        in: header
        required: true
        schema:
          type: string
      - name: Date
        description: The date and time at which the message was originated in 'RFC 1123' format
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        description: The media type of the request (e.g., 'application/json')
        in: header
        required: true
        schema:
          type: string
      - name: Content-Length
        description: The length of the request body in octets (8-bit bytes)
        in: header
        required: true
        schema:
          type: integer
      responses:
        200:
          description: Collection of Screening Results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreeningResultCollection'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/ScreeningResultCollection'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/CannotReturnResponse'
        415:
          $ref: '#/components/responses/UnsupportedMediaType'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/UnexpectedError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreeningRequest'
        description: Screening Request
        required: true
  /reference/countries:
    get:
      operationId: getCountries
      tags:
      - Zfs
      summary: London Stock Exchange Group Get Map of country codes and country names
      description: Get Map of ISO-3166-1 alpha-3 country codes and country names in English
      parameters:
      - name: Authorization
        description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details)
        in: header
        required: true
        schema:
          type: string
      - name: Date
        description: The date and time at which the message was originated in 'RFC 1123' format
        in: header
        required: true
        schema:
          type: string
      responses:
        200:
          description: 'Map of ISO-3166-1 alpha-3 country codes and country names in English, where ISO-3166-1 alpha-3 country code

            is the Key and country name is the Value

            '
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/octet-stream:
              schema:
                type: object
                additionalProperties:
                  type: string
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        404:
          $ref: '#/components/responses/CannotReturnResponse'
        415:
          $ref: '#/components/responses/UnsupportedMediaType'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/UnexpectedError'
  /reference/records/{id}:
    get:
      operationId: getRecord
      tags:
      - Zfs
      summary: London Stock Exchange Group Get a record by its ID
      description: "Get a record by its ID.\n\nThis service returns a specific subclass of 'Entity', depending on its particular 'RecordEntityType' discriminator\nfield. Please note in the context of World-Check One, 'Record' and 'Entity' are synonymous concepts.\n\nFor 'Zero Footprint Screening (ZFS)', this endpoint should be called on the dedicated 'ZFS' gateway host.\n\nThe 'Entity' subclasses corresponding to each type of entity are:\n\n* 'COUNTRY' : 'CountryEntity'\n* 'INDIVIDUAL' : 'IndividualEntity'\n* 'ORGANISATION' : 'OrganisationEntity'\n* 'VESSEL' : 'VesselEntity'\n\nThe response may contain Special Interest Categories (SIC) record that depends on User subscription type to be able to analyze SIC risk:\nIf a User has subscription type is Premium or Premium Plus, the SIC details are returned for that entity in the 'sources' field.\n\nThe response will contain translated details of the 'details' section when Accept-Language header is specified.\n\nThe example response body:\n\n```\n    {\n      \"sources\": [\n        {\n          \"abbreviation\": \"M:1U5\",\n          \"creationDate\": \"2020-10-23T07:43:21Z\",\n          \"identifier\": \"b_trwc_M:1U5\",\n          \"importIdentifier\": null,\n          \"name\": \"Sexual Exploitation\",\n          \"provider\": null,\n          \"providerSourceStatus\": \"ACTIVE\",\n          \"regionOfAuthority\": null,\n          \"subscriptionCategory\": \"STANDARD\",\n          \"type\": {\n            \"category\": {\n              \"description\": \"Description for Special Interest Categories\",\n              \"identifier\": \"ec_6\",\n              \"name\": \"Special Interest Categories\",\n              \"providerSourceTypes\": []\n            },\n            \"identifier\": \"t_trwc_14\",\n            \"name\": \"Special Interest Categories\"\n          }\n        }\n      ]\n    }\n```\n"
      parameters:
      - name: Authorization
        in: header
        description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details).
        required: true
        schema:
          type: string
      - name: Date
        in: header
        description: The date and time at which the message was originated in 'RFC 1123' format.
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: Record identifier.
        required: true
        schema:
          type: string
      responses:
        200:
          description: Record response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entity'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Entity'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        404:
          $ref: '#/components/responses/CannotReturnResponse'
        410:
          $ref: '#/components/responses/InactiveResource'
        415:
          $ref: '#/components/responses/UnsupportedMediaType'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/UnexpectedError'
  /reference/providers/sources/{identifier}:
    put:
      operationId: createOrUpdateProviderSource
      tags:
      - Zfs
      summary: London Stock Exchange Group Create or update a provider source
      description: 'Create or update a provider source for uploading entity records to. An example usage would be for a client watchlist.

        '
      parameters:
      - name: Authorization
        description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details)
        in: header
        required: true
        schema:
          type: string
      - name: Date
        description: The date and time at which the message was originated in 'RFC 1123' format
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        description: The media type of the request (e.g., 'application/json')
        in: header
        required: true
        schema:
          type: string
      - name: Content-Length
        description: The length of the request body in octets (8-bit bytes)
        in: header
        required: true
        schema:
          type: integer
      - name: identifier
        description: Unique identifier for this provider source. Has to be alphanumeric.
        in: path
        required: true
        schema:
          type: string
      responses:
        204:
          description: Provider source definition updated
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        404:
          $ref: '#/components/responses/CannotReturnResponse'
        415:
          $ref: '#/components/responses/UnsupportedMediaType'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/UnexpectedError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProviderSource'
        description: Provider source details
        required: true
  /reference/watchlist:
    post:
      operationId: saveWatchlist
      tags:
      - Zfs
      summary: London Stock Exchange Group Maintain your Watchlist data
      description: "Maintain your Watchlist data using the following supported entity actions.\n\n* entityCreateOrUpdate - Add a new entity to your Watchlist or replace if it already exists.\n\n* entityDelete - Mark the given entity as deleted in your Watchlist.\n\n* entitySupersede - Supersede enables you to redirect matches against your superseded entity to a new entity. This\nis useful if you want to redirect users with existing matches against an old entity to a newer / more accurate\nversion of those entities.\n\n* entityPurge - Purge enables you to remove an entity as required by GDPR whereby the personally identifiable\ninformation is removed.\n\nDue to the large number of entries within a Watchlist it is not possible to update the entire Watchlist in a single request\nThe overall request must be split into blocks of up to 500 individual entity actions.\n\n\nThe response consists of a list of any entities which were not successfully processed and a reason for failure.\n\n**Note:** The client watchlist record may not be considered for re-screening if the 'modificationDate' field \n          has not been specified while modifying the record.\n"
      parameters:
      - name: Authorization
        description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security and Authentication details' documentation section for more details)
        in: header
        required: true
        schema:
          type: string
      - name: Date
        description: The date and time at which the message was originated in 'RFC 1123' format
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        description: The media type of the request (e.g., 'application/json')
        in: header
        required: true
        schema:
          type: string
      - name: Content-Length
        description: The length of the request body in octets (8-bit bytes)
        in: header
        required: true
        schema:
          type: integer
      responses:
        201:
          description: Request to maintain Watchlist data has succeeded. Please review the contents of WatchlistResponse errors for details on any individual entity actions which were not successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WatchlistResponse'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/WatchlistResponse'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        404:
          $ref: '#/components/responses/CannotReturnResponse'
        415:
          $ref: '#/components/responses/UnsupportedMediaType'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/UnexpectedError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WatchlistDataSet'
        description: A collection of maintenance actions to be performed on your Watchlist.
        required: true
components:
  schemas:
    IdentityDocument:
      type: object
      properties:
        entity:
          $ref: '#/components/schemas/Entity'
        expiryDate:
          type: string
        issueDate:
          type: string
        issuer:
          type: string
        locationType:
          $ref: '#/components/schemas/IdentityDocumentLocationType'
        number:
          type: string
        type:
          type: string
    EntityUpdatedDates:
      type: object
      properties:
        ageUpdated:
          type: string
          format: date-time
        aliasesUpdated:
          type: string
          format: date-time
        alternativeSpellingUpdated:
          type: string
          format: date-time
        asOfDateUpdated:
          type: string
          format: date-time
        categoryUpdated:
          type: string
          format: date-time
        citizenshipsUpdated:
          type: string
          format: date-time
        companiesUpdated:
          type: string
          format: date-time
        deceasedUpdated:
          type: string
          format: date-time
        dobsUpdated:
          type: string
          format: date-time
        eiUpdated:
          type: string
          format: date-time
        enteredUpdated:
          type: string
          format: date-time
        externalSourcesUpdated:
          type: string
          format: date-time
        firstNameUpdated:
          type: string
          format: date-time
        foreignAliasUpdated:
          type: string
          format: date-time
        furtherInformationUpdated:
          type: string
          format: date-time
        idNumbersUpdated:
          type: string
          format: date-time
        keywordsUpdated:
          type: string
          format: date-time
        lastNameUpdated:
          type: string
          format: date-time
        linkedToUpdated:
          type: string
          format: date-time
        locationsUpdated:
          type: string
          format: date-time
        lowQualityAliasesUpdated:
          type: string
          format: date-time
        passportsUpdated:
          type: string
          format: date-time
        placeOfBirthUpdated:
          type: string
          format: date-time
        positionUpdated:
          type: string
          format: date-time
        ssnUpdated:
          type: string
          format: date-time
        subCategoryUpdated:
          type: string
          format: date-time
        titleUpdated:
          type: string
          format: date-time
        updatecategoryUpdated:
          type: string
          format: date-time
        sicUpdated:
          type: string
          format: date-time
    TranslatedEntity:
      type: object
      description: Representation of translated entity.
      properties:
        translationDisclaimer:
          type: string
          description: Disclaimer for Translation Response.
        details:
          type: array
          description: A collection of translated entity details.
          items:
            $ref: '#/components/schemas/Detail'
    IdentityDocumentLocationType:
      type: object
      description: 'Represents the type of identity document location that includes the type of document, name, country

        and what type of entity it belongs to.

        '
      properties:
        country:
          $ref: '#/components/schemas/Country'
        name:
          type: string
        type:
          type: string
        entityTypes:
          type: array
          items:
            $ref: '#/components/schemas/EntityType'
    MatchedTerm:
      type: object
      description: Matched term of a Result.
      properties:
        term:
          type: string
        type:
          type: string
          description: Enumeration of available matched types. Includes DOCUMENT_ID unlike NameType.
          enum:
          - PRIMARY
          - AKA
          - AKAENHANCED
          - FKA
          - DBA
          - MAIDEN
          - LANG_VARIATION
          - PREVIOUS
          - VEHICLE_ID
          - LOW_QUALITY_AKA
          - NATIVE_AKA
          - DOCUMENT_ID
        isPartOfUpdatedResults:
          type: boolean
          description: "The flag indicating whether the matched term is still relevant to the case after changes to either \ncase details or admin settings or record details. Please note this field must not be used for filtering \nongoing screening updates.\n"
    Field:
      type: object
      description: 'Holds the value of a Custom Field or a Secondary Field. Valid value type for this field is specified

        in the corresponding FieldDefinition of CaseTemplateResponse. Extends [AbstractField](#AbstractField).

        '
      allOf:
      - $ref: '#/components/schemas/AbstractField'
      - type: object
        properties:
          value:
            type: string
            maxLength: 1000
            description: Value for this Field. To be used for fields with [FieldValueType] (#FieldValueType) other than `DATE`.
          dateTimeValue:
            type: string
            format: date-time
            maxLength: 255
            description: DateTime value for this Field. To be used for fields with [FieldValueType] (#FieldValueType) `DATE`.
    AbstractScreeningResult:
      type: object
      description: Generic common Result fields returned after a Case is screened
      required:
      - referenceId
      properties:
        resultId:
          type: string
          maxLength: 255
          description: Result identifier
        referenceId:
          type: string
          description: The reference ID of the matched Entity
          maxLength: 255
        matchStrength:
          type: string
          description: Matched Result Strength
          enum:
          - WEAK
          - MEDIUM
          - STRONG
          - EXACT
        matchScore:
          type: number
          description: the exact match score with value rounded to 2 decimal places
          format: double
        matchedTerm:
          type: string
          description: Matched term for the Result. DEPRECATED in flavour of matchedTerms field
          maxLength: 1000
        matchedTerms:
          type: array
          description: List of matched terms for the result with resultId.
          items:
            $ref: '#/components/schemas/MatchedTerm'
        submittedTerm:
          type: string
          description: Submitted term for the Result
          maxLength: 1000
        matchedNameType:
          type: string
          description: Watchlist Profile Name Type enumeration. DEPRECATED in flavour of matchedTerms field
          enum:
          - PRIMARY
          - AKA
          - AKAENHANCED
          - FKA
          - DBA
          - MAIDEN
          - LANG_VARIATION
          - PREVIOUS
          - VEHICLE_ID
          - LOW_QUALITY_AKA
          - NATIVE_AKA
          - DOCUMENT_ID
        secondaryFieldResults:
          type: array
          description: Match results for Case secondary fields.
          items:
            $ref: '#/components/schemas/SecondaryFieldResult'
        sources:
          type: array
          description: 'Set of [ProviderSource](#ProviderSource)s, each of which contains this Result''s Entity and was used to screen

            the Case when this Result was last found.

            '
          items:
            type: string
            description: '[ProviderSource] (#ProviderSource) Identifier.

              '
        categories:
          type: array
          description: 'Set of [ProviderSourceTypeCategory] (#ProviderSourceTypeCategoryDetail) names of this Result''s sources.

            '
          items:
            type: string
            description: '[ProviderSourceTypeCategory] (#ProviderSourceTypeCategoryDetail) Name.

              '
        creationDate:
          type: string
          format: date-time
          description: Result creation date and time.
        modificationDate:
          type: string
          format: date-time
          description: Result modification date and time.
        lastAlertDate:
          type: string
          format: date-time
          description: Last alert date of the matched result term.
        modifier:
          description: The modifier of the matched result term.
          $ref: '#/components/schemas/UserSummary'
        resolution:
          $ref: '#/components/schemas/Resolution'
        resultReview:
          $ref: '#/components/schemas/Review'
    Group:
      type: object
      description: Structure of Groups accessible by user
      required:
      - id
      - name
      properties:
        id:
          type: string
          description: Group ID
          maxLength: 255
        parentId:
          type: string
          description: Parent Group ID
          maxLength: 255
        name:
          type: string
          description: Name for the Group
          maxLength: 255
        hasChildren:
          type: boolean
          default: false
        children:
          type: array
          description:

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/london-stock-exchange-group/refs/heads/main/openapi/london-stock-exchange-group-zfs-api-openapi.yml