Veryfi OCR API — Checks

naftiko: 1.0.0-alpha2
info:
  label: Veryfi OCR API — Checks
  description: 'Veryfi OCR API — Checks. 4 operations. Lead operation: Process a Check. Self-contained Naftiko capability
    covering one Veryfi business surface.'
  tags:
  - Veryfi
  - Checks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VERYFI_API_KEY: VERYFI_API_KEY
capability:
  consumes:
  - type: http
    namespace: ocr-checks
    baseUri: https://api.veryfi.com/api/v8
    description: Veryfi OCR API — Checks business capability. Self-contained, no shared references.
    resources:
    - name: partner-checks
      path: /partner/checks
      operations:
      - name: processcheck
        method: POST
        description: Process a Check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listchecks
        method: GET
        description: List All Checks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: partner-checks-documentId
      path: /partner/checks/{documentId}
      operations:
      - name: getcheck
        method: GET
        description: Get a Check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: documentId
          in: path
          type: integer
          required: true
      - name: deletecheck
        method: DELETE
        description: Delete a Check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: documentId
          in: path
          type: integer
          required: true
    authentication:
      type: apikey
      key: CLIENT-ID
      value: '{{env.VERYFI_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: ocr-checks-rest
    port: 8080
    description: REST adapter for Veryfi OCR API — Checks. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/partner/checks
      name: partner-checks
      description: REST surface for partner-checks.
      operations:
      - method: POST
        name: processcheck
        description: Process a Check
        call: ocr-checks.processcheck
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listchecks
        description: List All Checks
        call: ocr-checks.listchecks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/partner/checks/{documentid}
      name: partner-checks-documentid
      description: REST surface for partner-checks-documentId.
      operations:
      - method: GET
        name: getcheck
        description: Get a Check
        call: ocr-checks.getcheck
        with:
          documentId: rest.documentId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecheck
        description: Delete a Check
        call: ocr-checks.deletecheck
        with:
          documentId: rest.documentId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ocr-checks-mcp
    port: 9090
    transport: http
    description: MCP adapter for Veryfi OCR API — Checks. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: process-check
      description: Process a Check
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ocr-checks.processcheck
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-checks
      description: List All Checks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ocr-checks.listchecks
      outputParameters:
      - type: object
        mapping: $.
    - name: get-check
      description: Get a Check
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ocr-checks.getcheck
      with:
        documentId: tools.documentId
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-check
      description: Delete a Check
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ocr-checks.deletecheck
      with:
        documentId: tools.documentId
      outputParameters:
      - type: object
        mapping: $.