SWIFT SwiftRef API — National IDs

naftiko: 1.0.0-alpha2
info:
  label: SWIFT SwiftRef API — National IDs
  description: 'SWIFT SwiftRef API — National IDs. 3 operations. Lead operation: Get National ID Details. Self-contained Naftiko
    capability covering one Swift business surface.'
  tags:
  - Swift
  - National IDs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SWIFT_API_KEY: SWIFT_API_KEY
capability:
  consumes:
  - type: http
    namespace: swiftref-national-ids
    baseUri: https://api.swift.com/swiftrefdata
    description: SWIFT SwiftRef API — National IDs business capability. Self-contained, no shared references.
    resources:
    - name: v2-national_ids-national_id
      path: /v2/national_ids/{national_id}
      operations:
      - name: getnationalid
        method: GET
        description: Get National ID Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v2-national_ids-national_id-bics
      path: /v2/national_ids/{national_id}/bics
      operations:
      - name: getbicsfornationalid
        method: GET
        description: Get BICs for National ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v2-national_ids-national_id-validity
      path: /v2/national_ids/{national_id}/validity
      operations:
      - name: validatenationalid
        method: GET
        description: Validate National ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SWIFT_API_KEY}}'
  exposes:
  - type: rest
    namespace: swiftref-national-ids-rest
    port: 8080
    description: REST adapter for SWIFT SwiftRef API — National IDs. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v2/national-ids/{national-id}
      name: v2-national-ids-national-id
      description: REST surface for v2-national_ids-national_id.
      operations:
      - method: GET
        name: getnationalid
        description: Get National ID Details
        call: swiftref-national-ids.getnationalid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/national-ids/{national-id}/bics
      name: v2-national-ids-national-id-bics
      description: REST surface for v2-national_ids-national_id-bics.
      operations:
      - method: GET
        name: getbicsfornationalid
        description: Get BICs for National ID
        call: swiftref-national-ids.getbicsfornationalid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/national-ids/{national-id}/validity
      name: v2-national-ids-national-id-validity
      description: REST surface for v2-national_ids-national_id-validity.
      operations:
      - method: GET
        name: validatenationalid
        description: Validate National ID
        call: swiftref-national-ids.validatenationalid
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: swiftref-national-ids-mcp
    port: 9090
    transport: http
    description: MCP adapter for SWIFT SwiftRef API — National IDs. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-national-id-details
      description: Get National ID Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: swiftref-national-ids.getnationalid
      outputParameters:
      - type: object
        mapping: $.
    - name: get-bics-national-id
      description: Get BICs for National ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: swiftref-national-ids.getbicsfornationalid
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-national-id
      description: Validate National ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: swiftref-national-ids.validatenationalid
      outputParameters:
      - type: object
        mapping: $.