Harbor Compliance

opencollection: 1.0.0
info:
  name: Harbor Compliance API
  version: '1.0'
request:
  auth:
    type: apikey
    key: X-API-Key
    value: '{{X-API-Key}}'
    placement: header
items:
- info:
    name: Entities
    type: folder
  items:
  - info:
      name: Harbor Compliance List business entities
      type: http
    http:
      method: GET
      url: https://api.harborcompliance.com/v1/entities
      params:
      - name: page
        value: ''
        type: query
        description: Page number for paginated results (1-based).
      - name: per_page
        value: ''
        type: query
        description: Number of results per page.
      - name: state
        value: ''
        type: query
        description: Filter entities by state of formation (two-letter state code).
      - name: entity_type
        value: ''
        type: query
        description: Filter by entity type.
      - name: status
        value: ''
        type: query
        description: Filter by entity status.
    docs: Returns a paginated list of business entities managed under the partner account. Results can be filtered by entity
      type, state, and status.
  - info:
      name: Harbor Compliance Create a business entity
      type: http
    http:
      method: POST
      url: https://api.harborcompliance.com/v1/entities
      body:
        type: json
        data: '{}'
    docs: Creates a new business entity record in Harbor Compliance. This registers the entity for compliance tracking and
      monitoring across applicable jurisdictions.
  - info:
      name: Harbor Compliance Get a business entity
      type: http
    http:
      method: GET
      url: https://api.harborcompliance.com/v1/entities/:entityId
      params:
      - name: entityId
        value: ''
        type: path
        description: Unique identifier for the business entity.
    docs: Retrieves detailed information about a specific business entity including its formation details, registered agent,
      compliance status, and active licenses.
  - info:
      name: Harbor Compliance Update a business entity
      type: http
    http:
      method: PATCH
      url: https://api.harborcompliance.com/v1/entities/:entityId
      params:
      - name: entityId
        value: ''
        type: path
        description: Unique identifier for the business entity.
      body:
        type: json
        data: '{}'
    docs: Updates mutable fields on a business entity record such as the contact information, principal address, and officer
      details.
- info:
    name: Compliance Filings
    type: folder
  items:
  - info:
      name: Harbor Compliance Get compliance status for an entity
      type: http
    http:
      method: GET
      url: https://api.harborcompliance.com/v1/entities/:entityId/compliance
      params:
      - name: entityId
        value: ''
        type: path
        description: Unique identifier for the business entity.
    docs: Returns the full compliance status for a business entity including upcoming filing deadlines, overdue items, and
      a summary of active compliance requirements across all jurisdictions where the entity operates.
  - info:
      name: Harbor Compliance List compliance filings
      type: http
    http:
      method: GET
      url: https://api.harborcompliance.com/v1/filings
      params:
      - name: page
        value: ''
        type: query
        description: Page number for paginated results (1-based).
      - name: per_page
        value: ''
        type: query
        description: Number of results per page.
      - name: entity_id
        value: ''
        type: query
        description: Filter filings by entity identifier.
      - name: state
        value: ''
        type: query
        description: Filter filings by state jurisdiction.
      - name: status
        value: ''
        type: query
        description: Filter by filing status.
      - name: due_before
        value: ''
        type: query
        description: Filter filings due before this date (ISO 8601 date).
    docs: Returns a paginated list of compliance filings including annual reports, statements of information, and other required
      regulatory submissions. Results can be filtered by entity, state, filing type, and status.
  - info:
      name: Harbor Compliance Get a compliance filing
      type: http
    http:
      method: GET
      url: https://api.harborcompliance.com/v1/filings/:filingId
      params:
      - name: filingId
        value: ''
        type: path
        description: Unique identifier for the compliance filing.
    docs: Retrieves details about a specific compliance filing including its type, due date, status, and any documents associated
      with the filing.
- info:
    name: Licenses
    type: folder
  items:
  - info:
      name: Harbor Compliance List business licenses
      type: http
    http:
      method: GET
      url: https://api.harborcompliance.com/v1/licenses
      params:
      - name: page
        value: ''
        type: query
        description: Page number for paginated results (1-based).
      - name: per_page
        value: ''
        type: query
        description: Number of results per page.
      - name: entity_id
        value: ''
        type: query
        description: Filter licenses by entity identifier.
      - name: state
        value: ''
        type: query
        description: Filter licenses by state jurisdiction.
      - name: status
        value: ''
        type: query
        description: Filter by license status.
    docs: Returns a paginated list of business licenses managed for partner entities. Licenses can be filtered by entity,
      jurisdiction, license type, and status.
  - info:
      name: Harbor Compliance Create a license application
      type: http
    http:
      method: POST
      url: https://api.harborcompliance.com/v1/licenses
      body:
        type: json
        data: '{}'
    docs: Submits a new business license application for a specified entity and jurisdiction. Harbor Compliance will process
      the application and update the status as it progresses through the licensing workflow.
  - info:
      name: Harbor Compliance Get a business license
      type: http
    http:
      method: GET
      url: https://api.harborcompliance.com/v1/licenses/:licenseId
      params:
      - name: licenseId
        value: ''
        type: path
        description: Unique identifier for the business license.
    docs: Retrieves detailed information about a specific business license including its current status, expiration date,
      renewal requirements, and associated filings.
  - info:
      name: Harbor Compliance Renew a business license
      type: http
    http:
      method: POST
      url: https://api.harborcompliance.com/v1/licenses/:licenseId/renew
      params:
      - name: licenseId
        value: ''
        type: path
        description: Unique identifier for the business license.
      body:
        type: json
        data: '{}'
    docs: Initiates the renewal process for an existing business license. This creates a renewal order that Harbor Compliance
      will process through the appropriate jurisdiction's renewal workflow.
- info:
    name: Registered Agents
    type: folder
  items:
  - info:
      name: Harbor Compliance List registered agent appointments
      type: http
    http:
      method: GET
      url: https://api.harborcompliance.com/v1/registered-agents
      params:
      - name: page
        value: ''
        type: query
        description: Page number for paginated results (1-based).
      - name: per_page
        value: ''
        type: query
        description: Number of results per page.
      - name: entity_id
        value: ''
        type: query
        description: Filter by entity identifier.
      - name: state
        value: ''
        type: query
        description: Filter by state jurisdiction.
    docs: Returns a paginated list of registered agent appointments for entities managed under the partner account. Includes
      appointment status and jurisdiction details.
  - info:
      name: Harbor Compliance Appoint a registered agent
      type: http
    http:
      method: POST
      url: https://api.harborcompliance.com/v1/registered-agents
      body:
        type: json
        data: '{}'
    docs: Creates a new registered agent appointment for a business entity in a specified state. Harbor Compliance will file
      the necessary paperwork with the state to formalize the appointment.
  - info:
      name: Harbor Compliance Get a registered agent appointment
      type: http
    http:
      method: GET
      url: https://api.harborcompliance.com/v1/registered-agents/:agentId
      params:
      - name: agentId
        value: ''
        type: path
        description: Unique identifier for the registered agent appointment.
    docs: Retrieves details about a specific registered agent appointment including the agent's address, appointment status,
      and associated entity.
- info:
    name: Jurisdictions
    type: folder
  items:
  - info:
      name: Harbor Compliance List jurisdictions
      type: http
    http:
      method: GET
      url: https://api.harborcompliance.com/v1/jurisdictions
      params:
      - name: entity_type
        value: ''
        type: query
        description: Filter jurisdictions by supported entity type.
    docs: Returns a list of all supported jurisdictions with their compliance requirements, filing fees, and annual report
      due dates.
  - info:
      name: Harbor Compliance Get jurisdiction details
      type: http
    http:
      method: GET
      url: https://api.harborcompliance.com/v1/jurisdictions/:state
      params:
      - name: state
        value: ''
        type: path
        description: Two-letter state code (e.g., CA, NY, DE).
    docs: Retrieves detailed compliance requirements for a specific state jurisdiction including annual report deadlines,
      filing fees, and registered agent requirements by entity type.
- info:
    name: Orders
    type: folder
  items:
  - info:
      name: Harbor Compliance List service orders
      type: http
    http:
      method: GET
      url: https://api.harborcompliance.com/v1/orders
      params:
      - name: page
        value: ''
        type: query
        description: Page number for paginated results (1-based).
      - name: per_page
        value: ''
        type: query
        description: Number of results per page.
      - name: entity_id
        value: ''
        type: query
        description: Filter orders by entity identifier.
      - name: status
        value: ''
        type: query
        description: Filter by order status.
    docs: Returns a paginated list of compliance service orders placed through the Harbor Compliance partner account. Orders
      represent discrete compliance tasks being fulfilled by Harbor Compliance staff.
  - info:
      name: Harbor Compliance Get a service order
      type: http
    http:
      method: GET
      url: https://api.harborcompliance.com/v1/orders/:orderId
      params:
      - name: orderId
        value: ''
        type: path
        description: Unique identifier for the service order.
    docs: Retrieves details about a specific compliance service order including its current status, associated entity, service
      type, and any documents produced.
bundled: true