London Stock Exchange Group LSEG World-Check One API

naftiko: 1.0.0-alpha2
info:
  label: London Stock Exchange Group LSEG World-Check One 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 On'
  tags:
  - London
  - Stock
  - Exchange
  - Group
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: london-stock-exchange-group
    baseUri: https://api.example.com
    description: London Stock Exchange Group LSEG World-Check One API HTTP API.
    resources:
    - name: apiinfo
      path: /apiInfo
      operations:
      - name: getapiinfo
        method: GET
        description: London Stock Exchange Group Get information about the Public API.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups
      path: /groups
      operations:
      - name: getgroups
        method: GET
        description: London Stock Exchange Group Get all the top-level groups with their immediate descendants
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-groupid
      path: /groups/{groupId}
      operations:
      - name: getgroupbyid
        method: GET
        description: London Stock Exchange Group Get a specified group including its immediate descendants
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: groupId
          in: path
          type: string
          required: true
          description: Group ID under which we wish to retrieve children groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-groupid-casetemplate
      path: /groups/{groupId}/caseTemplate
      operations:
      - name: getcasetemplateforgroup
        method: GET
        description: London Stock Exchange Group Get the CaseTemplate for the given Group
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: groupId
          in: path
          type: string
          required: true
          description: Group ID under which we wish to manage Cases and perform screening
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-groupid-resolutiontoolkit
      path: /groups/{groupId}/resolutionToolkit
      operations:
      - name: getresolutiontoolkitforgroup
        method: GET
        description: London Stock Exchange Group Get the ResolutionToolkit for the given Group.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format.
        - name: groupId
          in: path
          type: string
          required: true
          description: ID of the Group to which the resolution toolkit belongs.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-groupid-resolutiontoolkits
      path: /groups/{groupId}/resolutionToolkits
      operations:
      - name: getresolutiontoolkitsforgroup
        method: GET
        description: London Stock Exchange Group Get all the ResolutionToolkits for the given Group
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: groupId
          in: path
          type: string
          required: true
          description: ID of the Group to which the resolution toolkits belong.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-groupid-resolutiontoolkits-providertype
      path: /groups/{groupId}/resolutionToolkits/{providerType}
      operations:
      - name: getresolutiontoolkitforgroupwithprovidertype
        method: GET
        description: London Stock Exchange Group Get the ResolutionToolkit for a specific provider type for the given Group
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: groupId
          in: path
          type: string
          required: true
          description: ID of the Group to which the resolution toolkit belongs.
        - name: providerType
          in: path
          type: string
          required: true
          description: Provider type for which the resolution toolkit applies.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: casereferences
      path: /caseReferences
      operations:
      - name: getcasereference
        method: GET
        description: London Stock Exchange Group Return the CaseReference (caseId, caseSystemId) for a caseId
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: caseId
          in: query
          type: string
          required: true
          description: Case ID provided by the client or else generated by the system for the client
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases
      path: /cases
      operations:
      - name: savecase
        method: POST
        description: London Stock Exchange Group Create a new case
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: Content-Type
          in: header
          type: string
          required: true
          description: The media type of the request (e.g., 'application/json')
        - name: Content-Length
          in: header
          type: string
          required: true
          description: The length of the request body in octets (8-bit bytes)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-screeningrequest
      path: /cases/screeningRequest
      operations:
      - name: screen
        method: POST
        description: London Stock Exchange Group Perform synchronous screening for a new case
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: Content-Type
          in: header
          type: string
          required: true
          description: The media type of the request (e.g., 'application/json')
        - name: Content-Length
          in: header
          type: string
          required: true
          description: The length of the request body in octets (8-bit bytes)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-casesystemid
      path: /cases/{caseSystemId}
      operations:
      - name: updateexistingcase
        method: PUT
        description: London Stock Exchange Group Update an existing Case by its caseSystemId
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: Content-Type
          in: header
          type: string
          required: true
          description: The media type of the request (e.g., 'application/json')
        - name: Content-Length
          in: header
          type: string
          required: true
          description: The length of the request body in octets (8-bit bytes)
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: System generated ID for the Case
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: partialupdatecase
        method: PATCH
        description: London Stock Exchange Group Partial update an existing Case by its caseSystemId
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: Content-Type
          in: header
          type: string
          required: true
          description: The media type of the request (e.g., 'application/json')
        - name: Content-Length
          in: header
          type: string
          required: true
          description: The length of the request body in octets (8-bit bytes)
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: System generated ID for the Case
        - name: screen
          in: query
          type: string
          description: Screen mode
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getcase
        method: GET
        description: London Stock Exchange Group Fetch Full Case Details
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: System generated ID for the Case
        - name: aggregatedSummary
          in: query
          type: string
          description: Flag to enable aggregated summary for case
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletecase
        method: DELETE
        description: London Stock Exchange Group Delete a Case
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: System generated ID for the Case
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-casesystemid-screeningrequest
      path: /cases/{caseSystemId}/screeningRequest
      operations:
      - name: screencase
        method: POST
        description: London Stock Exchange Group Request full or delta screening for an existing Case.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format.
        - name: Content-Type
          in: header
          type: string
          description: The media type of the request (e.g., 'application/json').
        - name: Content-Length
          in: header
          type: string
          description: The length of the request body in octets (8-bit bytes).
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: System generated ID for the Case.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-casesystemid-ongoingscreening
      path: /cases/{caseSystemId}/ongoingScreening
      operations:
      - name: enableongoingscreening
        method: PUT
        description: London Stock Exchange Group Enable OGS for a Case.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format.
        - name: Content-Type
          in: header
          type: string
          required: true
          description: The media type of the request (e.g., 'application/json').
        - name: Content-Length
          in: header
          type: string
          required: true
          description: The length of the request body in octets (8-bit bytes).
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: System generated ID for the Case.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: disableongoingscreening
        method: DELETE
        description: London Stock Exchange Group Disable OGS for a Case.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format.
        - name: Content-Type
          in: header
          type: string
          required: true
          description: The media type of the request (e.g., 'application/json').
        - name: Content-Length
          in: header
          type: string
          required: true
          description: The length of the request body in octets (8-bit bytes).
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: System generated ID for the Case.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-casesystemid-archive
      path: /cases/{caseSystemId}/archive
      operations:
      - name: archivecase
        method: PUT
        description: London Stock Exchange Group Archive a Case.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format.
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: System generated ID for the Case
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: unarchive
        method: DELETE
        description: London Stock Exchange Group Unarchive a Case
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: System generated ID for the Case
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-bulk-archive
      path: /cases/bulk/archive
      operations:
      - name: archivecases
        method: POST
        description: London Stock Exchange Group Bulk Update Archive States
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: Content-Type
          in: header
          type: string
          required: true
          description: The media type of the request (e.g., 'application/json')
        - name: Content-Length
          in: header
          type: string
          required: true
          description: The length of the request body in octets (8-bit bytes)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-bulk-assign
      path: /cases/bulk/assign
      operations:
      - name: assigncases
        method: POST
        description: London Stock Exchange Group Bulk Update Case Assignments
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: Content-Type
          in: header
          type: string
          required: true
          description: The media type of the request (e.g., 'application/json')
        - name: Content-Length
          in: header
          type: string
          required: true
          description: The length of the request body in octets (8-bit bytes)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-bulk-delete
      path: /cases/bulk/delete
      operations:
      - name: deletecases
        method: POST
        description: London Stock Exchange Group Bulk Delete Cases
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: Content-Type
          in: header
          type: string
          required: true
          description: The media type of the request (e.g., 'application/json')
        - name: Content-Length
          in: header
          type: string
          required: true
          description: The length of the request body in octets (8-bit bytes)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-bulk-move
      path: /cases/bulk/move
      operations:
      - name: updatecasesowner
        method: POST
        description: London Stock Exchange Group Bulk Move Cases Between Groups
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: Content-Type
          in: header
          type: string
          required: true
          description: The media type of the request (e.g., 'application/json')
        - name: Content-Length
          in: header
          type: string
          required: true
          description: The length of the request body in octets (8-bit bytes)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-bulk-ongoingscreening
      path: /cases/bulk/ongoingScreening
      operations:
      - name: toggleongoingscreeningbyprovidertypes
        method: POST
        description: London Stock Exchange Group Bulk Update Ongoing Screening States
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: Content-Type
          in: header
          type: string
          required: true
          description: The media type of the request (e.g., 'application/json')
        - name: Content-Length
          in: header
          type: string
          required: true
          description: The length of the request body in octets (8-bit bytes)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-bulk-link
      path: /cases/bulk/link
      operations:
      - name: linkcases
        method: POST
        description: London Stock Exchange Group Bulk Update Case Links
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: Content-Type
          in: header
          type: string
          required: true
          description: The media type of the request (e.g., 'application/json')
        - name: Content-Length
          in: header
          type: string
          required: true
          description: The length of the request body in octets (8-bit bytes)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-casesystemid-results
      path: /cases/{caseSystemId}/results
      operations:
      - name: getresults
        method: GET
        description: London Stock Exchange Group Get collection of Results for a Case by its caseSystemId
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: System generated ID for a Case
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-casesystemid-results-review
      path: /cases/{caseSystemId}/results/review
      operations:
      - name: reviewresults
        method: PUT
        description: London Stock Exchange Group Add a review remark to the specified result IDs for the given case
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format
        - name: Content-Type
          in: header
          type: string
          required: true
          description: The media type of the request (e.g., 'application/json')
        - name: Content-Length
          in: header
          type: string
          required: true
          description: The length of the request body in octets (8-bit bytes)
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: System generated ID for the Case
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cases-casesystemid-results-resolution
      path: /cases/{caseSystemId}/results/resolution
      operations:
      - name: resolveresults
        method: PUT
        description: London Stock Exchange Group Resolves a list of results.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: The authorization credentials including 'keyId', 'algorithm', 'headers', 'signature' (see 'Security
            and Authentication details' documentation section for more d
        - name: Date
          in: header
          type: string
          required: true
          description: The date and time at which the message was originated in 'RFC 1123' format.
        - name: Content-Type
          in: header
          type: string
          require

# --- truncated at 32 KB (122 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/london-stock-exchange-group/refs/heads/main/capabilities/london-stock-exchange-group-capability.yaml