naftiko: 1.0.0-alpha2
info:
  label: Harbor Compliance API
  description: The Harbor Compliance API enables partners to integrate compliance management capabilities into their platforms.
    The API provides programmatic access to business licensing, registered agent services, compliance tracking, and entity
    management workflows. Partners can automate compliance tasks, monitor filing deadlines, manage registered agent appointments,
    and track licensing requirements across jurisdictions.
  tags:
  - Harbor
  - Compliance
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: harbor-compliance
    baseUri: https://api.harborcompliance.com/v1
    description: Harbor Compliance API HTTP API.
    authentication:
      type: apikey
      in: header
      name: X-API-Key
      value: '{{HARBOR_COMPLIANCE_TOKEN}}'
    resources:
    - name: entities
      path: /entities
      operations:
      - name: listentities
        method: GET
        description: Harbor Compliance List business entities
        inputParameters:
        - name: state
          in: query
          type: string
          description: Filter entities by state of formation (two-letter state code).
        - name: entity_type
          in: query
          type: string
          description: Filter by entity type.
        - name: status
          in: query
          type: string
          description: Filter by entity status.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createentity
        method: POST
        description: Harbor Compliance Create a business entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: entities-entityid
      path: /entities/{entityId}
      operations:
      - name: getentity
        method: GET
        description: Harbor Compliance Get a business entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateentity
        method: PATCH
        description: Harbor Compliance Update a business entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: entities-entityid-compliance
      path: /entities/{entityId}/compliance
      operations:
      - name: getentitycompliance
        method: GET
        description: Harbor Compliance Get compliance status for an entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: licenses
      path: /licenses
      operations:
      - name: listlicenses
        method: GET
        description: Harbor Compliance List business licenses
        inputParameters:
        - name: entity_id
          in: query
          type: string
          description: Filter licenses by entity identifier.
        - name: state
          in: query
          type: string
          description: Filter licenses by state jurisdiction.
        - name: status
          in: query
          type: string
          description: Filter by license status.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createlicense
        method: POST
        description: Harbor Compliance Create a license application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: licenses-licenseid
      path: /licenses/{licenseId}
      operations:
      - name: getlicense
        method: GET
        description: Harbor Compliance Get a business license
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: licenses-licenseid-renew
      path: /licenses/{licenseId}/renew
      operations:
      - name: renewlicense
        method: POST
        description: Harbor Compliance Renew a business license
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: registered-agents
      path: /registered-agents
      operations:
      - name: listregisteredagents
        method: GET
        description: Harbor Compliance List registered agent appointments
        inputParameters:
        - name: entity_id
          in: query
          type: string
          description: Filter by entity identifier.
        - name: state
          in: query
          type: string
          description: Filter by state jurisdiction.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createregisteredagentappointment
        method: POST
        description: Harbor Compliance Appoint a registered agent
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: registered-agents-agentid
      path: /registered-agents/{agentId}
      operations:
      - name: getregisteredagent
        method: GET
        description: Harbor Compliance Get a registered agent appointment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: filings
      path: /filings
      operations:
      - name: listfilings
        method: GET
        description: Harbor Compliance List compliance filings
        inputParameters:
        - name: entity_id
          in: query
          type: string
          description: Filter filings by entity identifier.
        - name: state
          in: query
          type: string
          description: Filter filings by state jurisdiction.
        - name: status
          in: query
          type: string
          description: Filter by filing status.
        - name: due_before
          in: query
          type: string
          description: Filter filings due before this date (ISO 8601 date).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: filings-filingid
      path: /filings/{filingId}
      operations:
      - name: getfiling
        method: GET
        description: Harbor Compliance Get a compliance filing
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: jurisdictions
      path: /jurisdictions
      operations:
      - name: listjurisdictions
        method: GET
        description: Harbor Compliance List jurisdictions
        inputParameters:
        - name: entity_type
          in: query
          type: string
          description: Filter jurisdictions by supported entity type.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: jurisdictions-state
      path: /jurisdictions/{state}
      operations:
      - name: getjurisdiction
        method: GET
        description: Harbor Compliance Get jurisdiction details
        inputParameters:
        - name: state
          in: path
          type: string
          required: true
          description: Two-letter state code (e.g., CA, NY, DE).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orders
      path: /orders
      operations:
      - name: listorders
        method: GET
        description: Harbor Compliance List service orders
        inputParameters:
        - name: entity_id
          in: query
          type: string
          description: Filter orders by entity identifier.
        - name: status
          in: query
          type: string
          description: Filter by order status.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orders-orderid
      path: /orders/{orderId}
      operations:
      - name: getorder
        method: GET
        description: Harbor Compliance Get a service order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: harbor-compliance-rest
    description: REST adapter for Harbor Compliance API.
    resources:
    - path: /entities
      name: listentities
      operations:
      - method: GET
        name: listentities
        description: Harbor Compliance List business entities
        call: harbor-compliance.listentities
        outputParameters:
        - type: object
          mapping: $.
    - path: /entities
      name: createentity
      operations:
      - method: POST
        name: createentity
        description: Harbor Compliance Create a business entity
        call: harbor-compliance.createentity
        outputParameters:
        - type: object
          mapping: $.
    - path: /entities/{entityId}
      name: getentity
      operations:
      - method: GET
        name: getentity
        description: Harbor Compliance Get a business entity
        call: harbor-compliance.getentity
        outputParameters:
        - type: object
          mapping: $.
    - path: /entities/{entityId}
      name: updateentity
      operations:
      - method: PATCH
        name: updateentity
        description: Harbor Compliance Update a business entity
        call: harbor-compliance.updateentity
        outputParameters:
        - type: object
          mapping: $.
    - path: /entities/{entityId}/compliance
      name: getentitycompliance
      operations:
      - method: GET
        name: getentitycompliance
        description: Harbor Compliance Get compliance status for an entity
        call: harbor-compliance.getentitycompliance
        outputParameters:
        - type: object
          mapping: $.
    - path: /licenses
      name: listlicenses
      operations:
      - method: GET
        name: listlicenses
        description: Harbor Compliance List business licenses
        call: harbor-compliance.listlicenses
        outputParameters:
        - type: object
          mapping: $.
    - path: /licenses
      name: createlicense
      operations:
      - method: POST
        name: createlicense
        description: Harbor Compliance Create a license application
        call: harbor-compliance.createlicense
        outputParameters:
        - type: object
          mapping: $.
    - path: /licenses/{licenseId}
      name: getlicense
      operations:
      - method: GET
        name: getlicense
        description: Harbor Compliance Get a business license
        call: harbor-compliance.getlicense
        outputParameters:
        - type: object
          mapping: $.
    - path: /licenses/{licenseId}/renew
      name: renewlicense
      operations:
      - method: POST
        name: renewlicense
        description: Harbor Compliance Renew a business license
        call: harbor-compliance.renewlicense
        outputParameters:
        - type: object
          mapping: $.
    - path: /registered-agents
      name: listregisteredagents
      operations:
      - method: GET
        name: listregisteredagents
        description: Harbor Compliance List registered agent appointments
        call: harbor-compliance.listregisteredagents
        outputParameters:
        - type: object
          mapping: $.
    - path: /registered-agents
      name: createregisteredagentappointment
      operations:
      - method: POST
        name: createregisteredagentappointment
        description: Harbor Compliance Appoint a registered agent
        call: harbor-compliance.createregisteredagentappointment
        outputParameters:
        - type: object
          mapping: $.
    - path: /registered-agents/{agentId}
      name: getregisteredagent
      operations:
      - method: GET
        name: getregisteredagent
        description: Harbor Compliance Get a registered agent appointment
        call: harbor-compliance.getregisteredagent
        outputParameters:
        - type: object
          mapping: $.
    - path: /filings
      name: listfilings
      operations:
      - method: GET
        name: listfilings
        description: Harbor Compliance List compliance filings
        call: harbor-compliance.listfilings
        outputParameters:
        - type: object
          mapping: $.
    - path: /filings/{filingId}
      name: getfiling
      operations:
      - method: GET
        name: getfiling
        description: Harbor Compliance Get a compliance filing
        call: harbor-compliance.getfiling
        outputParameters:
        - type: object
          mapping: $.
    - path: /jurisdictions
      name: listjurisdictions
      operations:
      - method: GET
        name: listjurisdictions
        description: Harbor Compliance List jurisdictions
        call: harbor-compliance.listjurisdictions
        outputParameters:
        - type: object
          mapping: $.
    - path: /jurisdictions/{state}
      name: getjurisdiction
      operations:
      - method: GET
        name: getjurisdiction
        description: Harbor Compliance Get jurisdiction details
        call: harbor-compliance.getjurisdiction
        with:
          state: rest.state
        outputParameters:
        - type: object
          mapping: $.
    - path: /orders
      name: listorders
      operations:
      - method: GET
        name: listorders
        description: Harbor Compliance List service orders
        call: harbor-compliance.listorders
        outputParameters:
        - type: object
          mapping: $.
    - path: /orders/{orderId}
      name: getorder
      operations:
      - method: GET
        name: getorder
        description: Harbor Compliance Get a service order
        call: harbor-compliance.getorder
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: harbor-compliance-mcp
    transport: http
    description: MCP adapter for Harbor Compliance API for AI agent use.
    tools:
    - name: listentities
      description: Harbor Compliance List business entities
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance.listentities
      with:
        state: tools.state
        entity_type: tools.entity_type
        status: tools.status
      inputParameters:
      - name: state
        type: string
        description: Filter entities by state of formation (two-letter state code).
      - name: entity_type
        type: string
        description: Filter by entity type.
      - name: status
        type: string
        description: Filter by entity status.
      outputParameters:
      - type: object
        mapping: $.
    - name: createentity
      description: Harbor Compliance Create a business entity
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: harbor-compliance.createentity
      outputParameters:
      - type: object
        mapping: $.
    - name: getentity
      description: Harbor Compliance Get a business entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance.getentity
      outputParameters:
      - type: object
        mapping: $.
    - name: updateentity
      description: Harbor Compliance Update a business entity
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: harbor-compliance.updateentity
      outputParameters:
      - type: object
        mapping: $.
    - name: getentitycompliance
      description: Harbor Compliance Get compliance status for an entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance.getentitycompliance
      outputParameters:
      - type: object
        mapping: $.
    - name: listlicenses
      description: Harbor Compliance List business licenses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance.listlicenses
      with:
        entity_id: tools.entity_id
        state: tools.state
        status: tools.status
      inputParameters:
      - name: entity_id
        type: string
        description: Filter licenses by entity identifier.
      - name: state
        type: string
        description: Filter licenses by state jurisdiction.
      - name: status
        type: string
        description: Filter by license status.
      outputParameters:
      - type: object
        mapping: $.
    - name: createlicense
      description: Harbor Compliance Create a license application
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: harbor-compliance.createlicense
      outputParameters:
      - type: object
        mapping: $.
    - name: getlicense
      description: Harbor Compliance Get a business license
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance.getlicense
      outputParameters:
      - type: object
        mapping: $.
    - name: renewlicense
      description: Harbor Compliance Renew a business license
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: harbor-compliance.renewlicense
      outputParameters:
      - type: object
        mapping: $.
    - name: listregisteredagents
      description: Harbor Compliance List registered agent appointments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance.listregisteredagents
      with:
        entity_id: tools.entity_id
        state: tools.state
      inputParameters:
      - name: entity_id
        type: string
        description: Filter by entity identifier.
      - name: state
        type: string
        description: Filter by state jurisdiction.
      outputParameters:
      - type: object
        mapping: $.
    - name: createregisteredagentappointment
      description: Harbor Compliance Appoint a registered agent
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: harbor-compliance.createregisteredagentappointment
      outputParameters:
      - type: object
        mapping: $.
    - name: getregisteredagent
      description: Harbor Compliance Get a registered agent appointment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance.getregisteredagent
      outputParameters:
      - type: object
        mapping: $.
    - name: listfilings
      description: Harbor Compliance List compliance filings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance.listfilings
      with:
        entity_id: tools.entity_id
        state: tools.state
        status: tools.status
        due_before: tools.due_before
      inputParameters:
      - name: entity_id
        type: string
        description: Filter filings by entity identifier.
      - name: state
        type: string
        description: Filter filings by state jurisdiction.
      - name: status
        type: string
        description: Filter by filing status.
      - name: due_before
        type: string
        description: Filter filings due before this date (ISO 8601 date).
      outputParameters:
      - type: object
        mapping: $.
    - name: getfiling
      description: Harbor Compliance Get a compliance filing
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance.getfiling
      outputParameters:
      - type: object
        mapping: $.
    - name: listjurisdictions
      description: Harbor Compliance List jurisdictions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance.listjurisdictions
      with:
        entity_type: tools.entity_type
      inputParameters:
      - name: entity_type
        type: string
        description: Filter jurisdictions by supported entity type.
      outputParameters:
      - type: object
        mapping: $.
    - name: getjurisdiction
      description: Harbor Compliance Get jurisdiction details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance.getjurisdiction
      with:
        state: tools.state
      inputParameters:
      - name: state
        type: string
        description: Two-letter state code (e.g., CA, NY, DE).
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: listorders
      description: Harbor Compliance List service orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance.listorders
      with:
        entity_id: tools.entity_id
        status: tools.status
      inputParameters:
      - name: entity_id
        type: string
        description: Filter orders by entity identifier.
      - name: status
        type: string
        description: Filter by order status.
      outputParameters:
      - type: object
        mapping: $.
    - name: getorder
      description: Harbor Compliance Get a service order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance.getorder
      outputParameters:
      - type: object
        mapping: $.
binds:
- namespace: env
  keys:
    HARBOR_COMPLIANCE_TOKEN: HARBOR_COMPLIANCE_TOKEN