Refinitiv Qual-ID API — Configuration

naftiko: 1.0.0-alpha2
info:
  label: Refinitiv Qual-ID API — Configuration
  description: 'Refinitiv Qual-ID API — Configuration. 4 operations. Lead operation: Get Consent Requirements. Self-contained
    Naftiko capability covering one Refinitiv business surface.'
  tags:
  - Refinitiv
  - Configuration
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    REFINITIV_API_KEY: REFINITIV_API_KEY
capability:
  consumes:
  - type: http
    namespace: qual-id-configuration
    baseUri: https://api.globaldatacompany.com
    description: Refinitiv Qual-ID API — Configuration business capability. Self-contained, no shared references.
    resources:
    - name: configuration-v1-consents-configurationName-countryCode
      path: /configuration/v1/consents/{configurationName}/{countryCode}
      operations:
      - name: getconsents
        method: GET
        description: Get Consent Requirements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: configurationName
          in: path
          type: string
          description: The configuration name.
          required: true
        - name: countryCode
          in: path
          type: string
          description: ISO 3166-1 alpha-2 country code.
          required: true
    - name: configuration-v1-countrycodes-configurationName
      path: /configuration/v1/countrycodes/{configurationName}
      operations:
      - name: getcountrycodes
        method: GET
        description: Get Supported Country Codes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: configurationName
          in: path
          type: string
          description: The configuration name, such as Identity Verification.
          required: true
    - name: configuration-v1-fields-configurationName-countryCode
      path: /configuration/v1/fields/{configurationName}/{countryCode}
      operations:
      - name: getfields
        method: GET
        description: Get Verification Fields
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: configurationName
          in: path
          type: string
          description: The configuration name.
          required: true
        - name: countryCode
          in: path
          type: string
          description: ISO 3166-1 alpha-2 country code.
          required: true
    - name: configuration-v1-testentities-configurationName-countryCode
      path: /configuration/v1/testentities/{configurationName}/{countryCode}
      operations:
      - name: gettestentities
        method: GET
        description: Get Test Entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: configurationName
          in: path
          type: string
          description: The configuration name.
          required: true
        - name: countryCode
          in: path
          type: string
          description: ISO 3166-1 alpha-2 country code.
          required: true
    authentication:
      type: basic
      username: '{{env.REFINITIV_USER}}'
      password: '{{env.REFINITIV_PASS}}'
  exposes:
  - type: rest
    namespace: qual-id-configuration-rest
    port: 8080
    description: REST adapter for Refinitiv Qual-ID API — Configuration. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/configuration/v1/consents/{configurationname}/{countrycode}
      name: configuration-v1-consents-configurationname-countrycode
      description: REST surface for configuration-v1-consents-configurationName-countryCode.
      operations:
      - method: GET
        name: getconsents
        description: Get Consent Requirements
        call: qual-id-configuration.getconsents
        with:
          configurationName: rest.configurationName
          countryCode: rest.countryCode
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/configuration/v1/countrycodes/{configurationname}
      name: configuration-v1-countrycodes-configurationname
      description: REST surface for configuration-v1-countrycodes-configurationName.
      operations:
      - method: GET
        name: getcountrycodes
        description: Get Supported Country Codes
        call: qual-id-configuration.getcountrycodes
        with:
          configurationName: rest.configurationName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/configuration/v1/fields/{configurationname}/{countrycode}
      name: configuration-v1-fields-configurationname-countrycode
      description: REST surface for configuration-v1-fields-configurationName-countryCode.
      operations:
      - method: GET
        name: getfields
        description: Get Verification Fields
        call: qual-id-configuration.getfields
        with:
          configurationName: rest.configurationName
          countryCode: rest.countryCode
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/configuration/v1/testentities/{configurationname}/{countrycode}
      name: configuration-v1-testentities-configurationname-countrycode
      description: REST surface for configuration-v1-testentities-configurationName-countryCode.
      operations:
      - method: GET
        name: gettestentities
        description: Get Test Entities
        call: qual-id-configuration.gettestentities
        with:
          configurationName: rest.configurationName
          countryCode: rest.countryCode
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: qual-id-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for Refinitiv Qual-ID API — Configuration. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-consent-requirements
      description: Get Consent Requirements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qual-id-configuration.getconsents
      with:
        configurationName: tools.configurationName
        countryCode: tools.countryCode
      outputParameters:
      - type: object
        mapping: $.
    - name: get-supported-country-codes
      description: Get Supported Country Codes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qual-id-configuration.getcountrycodes
      with:
        configurationName: tools.configurationName
      outputParameters:
      - type: object
        mapping: $.
    - name: get-verification-fields
      description: Get Verification Fields
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qual-id-configuration.getfields
      with:
        configurationName: tools.configurationName
        countryCode: tools.countryCode
      outputParameters:
      - type: object
        mapping: $.
    - name: get-test-entities
      description: Get Test Entities
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qual-id-configuration.gettestentities
      with:
        configurationName: tools.configurationName
        countryCode: tools.countryCode
      outputParameters:
      - type: object
        mapping: $.