naftiko: 1.0.0-alpha2
info:
  label: Refinitiv Compliance Screening
  description: Unified workflow capability for compliance officers and KYC analysts screening entities and verifying identities
    using Refinitiv's World-Check risk intelligence database and PermID entity search. Supports onboarding, due diligence,
    AML, and ongoing monitoring workflows.
  tags:
  - Refinitiv
  - Compliance
  - KYC
  - AML
  - Screening
  - Due Diligence
  - World-Check
  created: '2026-05-02'
  modified: '2026-05-06'
binds:
- namespace: env
  keys:
    WORLD_CHECK_API_KEY: WORLD_CHECK_API_KEY
    WORLD_CHECK_API_SECRET: WORLD_CHECK_API_SECRET
    PERMID_APP_KEY: PERMID_APP_KEY
capability:
  consumes:
  - type: http
    namespace: refinitiv-world-check
    baseUri: https://api-worldcheck.refinitiv.com/v2
    description: World-Check One API for entity risk screening.
    authentication:
      type: apikey
      key: Authorization
      value: HMAC-SHA256 {{WORLD_CHECK_API_KEY}}:{{WORLD_CHECK_API_SECRET}}
      placement: header
    resources:
    - name: cases
      path: /cases
      description: Case management and screening.
      operations:
      - name: create-case-and-screen
        method: POST
        description: Create a case and perform synchronous screening.
        inputParameters: []
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        body:
          type: json
          data:
            entityType: '{{tools.entityType}}'
            name: '{{tools.name}}'
            groupId: '{{tools.groupId}}'
      - name: get-case
        method: GET
        description: Get case details.
        inputParameters:
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: Case system identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: update-case
        method: PUT
        description: Update an existing case.
        inputParameters:
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: Case system identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        body:
          type: json
          data:
            name: '{{tools.name}}'
      - name: delete-case
        method: DELETE
        description: Delete a case.
        inputParameters:
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: Case system identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: screening-results
      path: /cases
      description: Screening results management.
      operations:
      - name: get-screening-results
        method: GET
        description: Get screening results for a case.
        inputParameters:
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: Case system identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: resolve-screening-result
        method: PUT
        description: Resolve a screening match result.
        inputParameters:
        - name: caseSystemId
          in: path
          type: string
          required: true
          description: Case system identifier.
        - name: resultId
          in: path
          type: string
          required: true
          description: Result identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        body:
          type: json
          data:
            riskType: '{{tools.riskType}}'
            comments: '{{tools.comments}}'
    - name: groups
      path: /groups
      description: Group management.
      operations:
      - name: list-groups
        method: GET
        description: List available screening groups.
        inputParameters: []
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  - type: http
    namespace: refinitiv-permid
    baseUri: https://api-eit.refinitiv.com/permid
    description: PermID Entity Search REST API.
    authentication:
      type: apikey
      key: x-ag-access-token
      value: '{{PERMID_APP_KEY}}'
      placement: header
    resources:
    - name: entity-search
      path: /search
      description: Entity search and lookup.
      operations:
      - name: search-entities
        method: GET
        description: Search entities by query string.
        inputParameters:
        - name: q
          in: query
          type: string
          required: true
          description: Search query.
        - name: entityType
          in: query
          type: string
          required: false
          description: Entity type filter (organization, instrument, quote).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: intelligent-tagging
      path: /calais
      description: Entity extraction from text.
      operations:
      - name: tag-content
        method: POST
        description: Tag text content with financial entities.
        inputParameters: []
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        body:
          type: json
          data:
            content: '{{tools.content}}'
    - name: record-matching
      path: /match
      description: Match records to PermIDs.
      operations:
      - name: match-records
        method: POST
        description: Match entity records to PermID identifiers.
        inputParameters: []
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        body:
          type: json
          data:
            entity: '{{tools.entity}}'
  exposes:
  - type: rest
    port: 8081
    namespace: refinitiv-compliance-api
    description: Unified REST API for Refinitiv compliance and screening.
    resources:
    - path: /v1/screening/cases
      name: screening-cases
      description: Entity screening cases.
      operations:
      - method: POST
        name: create-and-screen
        description: Create a case and screen against World-Check.
        call: refinitiv-world-check.create-case-and-screen
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/screening/cases/{caseSystemId}
      name: screening-case-detail
      description: Case details.
      operations:
      - method: GET
        name: get-case
        description: Get screening case details.
        call: refinitiv-world-check.get-case
        with:
          caseSystemId: rest.caseSystemId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete-case
        description: Delete a screening case.
        call: refinitiv-world-check.delete-case
        with:
          caseSystemId: rest.caseSystemId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/screening/groups
      name: screening-groups
      description: Screening group configuration.
      operations:
      - method: GET
        name: list-groups
        description: List available screening groups.
        call: refinitiv-world-check.list-groups
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/entities/search
      name: entity-search
      description: Entity search via PermID.
      operations:
      - method: GET
        name: search-entities
        description: Search for organizations and instruments.
        call: refinitiv-permid.search-entities
        with:
          q: rest.q
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/entities/tag
      name: entity-tagging
      description: Intelligent entity tagging.
      operations:
      - method: POST
        name: tag-content
        description: Tag text with financial entities.
        call: refinitiv-permid.tag-content
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9081
    namespace: refinitiv-compliance-mcp
    transport: http
    description: MCP server for AI-assisted Refinitiv compliance screening.
    tools:
    - name: screen-entity
      description: Screen a company or individual against the World-Check risk intelligence database for KYC and AML compliance.
      hints:
        readOnly: false
        openWorld: false
      call: refinitiv-world-check.create-case-and-screen
      with:
        entityType: tools.entityType
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: get-screening-case
      description: Retrieve the current status and results of a World-Check screening case.
      hints:
        readOnly: true
        openWorld: false
      call: refinitiv-world-check.get-case
      with:
        caseSystemId: tools.caseSystemId
      outputParameters:
      - type: object
        mapping: $.
    - name: resolve-screening-result
      description: Resolve and annotate a World-Check screening match result with risk determination.
      hints:
        readOnly: false
        openWorld: false
      call: refinitiv-world-check.resolve-screening-result
      with:
        caseSystemId: tools.caseSystemId
        resultId: tools.resultId
      outputParameters:
      - type: object
        mapping: $.
    - name: list-screening-groups
      description: List available World-Check screening groups and their configurations.
      hints:
        readOnly: true
        openWorld: false
      call: refinitiv-world-check.list-groups
      outputParameters:
      - type: object
        mapping: $.
    - name: search-entities
      description: Search for organizations and instruments using PermID for pre-screening entity research.
      hints:
        readOnly: true
        openWorld: true
      call: refinitiv-permid.search-entities
      with:
        q: tools.query
      outputParameters:
      - type: object
        mapping: $.
    - name: tag-document-entities
      description: Extract and tag financial entities from document text using Intelligent Tagging.
      hints:
        readOnly: true
        openWorld: false
      call: refinitiv-permid.tag-content
      with:
        content: tools.content
      outputParameters:
      - type: object
        mapping: $.