Refinitiv Screening Results API

openapi: 3.2.0
info:
  title: Refinitiv World-Check One Screening Results API
  description: RESTful API for integrating LSEG World-Check screening capabilities into existing workflows and internal systems. It enables automated customer and third-party screening for onboarding, KYC, and due diligence processes against the World-Check risk intelligence database, supporting synchronous and asynchronous screening, ongoing monitoring, case management, and audit trail capabilities.
  version: 2.0.0
  contact:
    name: LSEG Developer Support
    url: https://developers.lseg.com/en/support
  termsOfService: https://developers.lseg.com/en/terms-and-conditions
servers:
- url: https://api-worldcheck.refinitiv.com/v2
  description: Production Server
security:
- hmacAuth: []
tags:
- name: Screening Results
  description: Operations for retrieving and managing screening results including matched profiles and resolution workflows.
paths:
  /cases/{caseSystemId}/results:
    get:
      operationId: getScreeningResults
      summary: Get Screening Results
      description: Retrieves detailed screening results for a specific case including all matched profiles, match strength indicators, and resolution status for each match.
      tags:
      - Screening Results
      parameters:
      - $ref: '#/components/parameters/caseSystemId'
      responses:
        '200':
          description: Screening results returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreeningResultsResponse'
        '401':
          description: Unauthorized
        '404':
          description: Case not found
  /cases/{caseSystemId}/results/{resultId}/resolution:
    put:
      operationId: resolveResult
      summary: Resolve a Screening Result
      description: Resolves a specific screening result match by assigning a resolution status such as True Positive, False Positive, or Unresolved. The valid resolution options depend on the group's resolution toolkit configuration.
      tags:
      - Screening Results
      parameters:
      - $ref: '#/components/parameters/caseSystemId'
      - name: resultId
        in: path
        required: true
        description: The unique identifier of the screening result to resolve.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResolutionRequest'
      responses:
        '200':
          description: Result resolved successfully
        '400':
          description: Invalid resolution request
        '401':
          description: Unauthorized
        '404':
          description: Result not found
components:
  schemas:
    ScreeningResult:
      type: object
      properties:
        resultId:
          type: string
          description: The unique identifier of the screening result.
        referenceId:
          type: string
          description: The World-Check reference profile identifier.
        matchStrength:
          type: string
          description: The strength of the match, such as EXACT, STRONG, MEDIUM, or WEAK.
        matchedTerm:
          type: string
          description: The name or term that was matched.
        submittedTerm:
          type: string
          description: The original term submitted for screening.
        matchedNameType:
          type: string
          description: The type of name matched, such as PRIMARY or ALIAS.
        categories:
          type: array
          items:
            type: string
          description: Categories assigned to the matched profile such as PEP, Sanctions, or Adverse Media.
        resolution:
          type: object
          description: The current resolution status of the result, null if unresolved.
          properties:
            statusId:
              type: string
              description: The resolution status identifier.
            riskId:
              type: string
              description: The risk level identifier.
            reasonId:
              type: string
              description: The resolution reason identifier.
    ResolutionRequest:
      type: object
      required:
      - statusId
      properties:
        statusId:
          type: string
          description: The resolution status to assign, from the resolution toolkit.
        riskId:
          type: string
          description: The risk level to assign, from the resolution toolkit.
        reasonId:
          type: string
          description: The reason for the resolution, from the resolution toolkit.
        remarks:
          type: string
          description: Free-text remarks or notes for the resolution.
    ScreeningResultsResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/ScreeningResult'
  parameters:
    caseSystemId:
      name: caseSystemId
      in: path
      required: true
      description: The system-generated unique identifier for the case.
      schema:
        type: string
  securitySchemes:
    hmacAuth:
      type: apiKey
      in: header
      name: Authorization
      description: HMAC-SHA256 authentication. All requests must include the API key and be signed with the API secret using HMAC-SHA256. The signature is computed over the request method, path, date, and body content, and included in the Authorization header as a base64-encoded value.
externalDocs:
  description: World-Check One API Documentation
  url: https://developers.lseg.com/en/api-catalog/customer-and-third-party-screening/world-check-one-api/documentation