Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Harbor Compliance Licenses API

Business license applications, renewals, and status tracking across jurisdictions.

Harbor Compliance Licenses API is one of 6 APIs that Harbor Compliance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Licenses. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and 1 JSON Schema.

This API exposes 4 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.harborcompliance.com/v1.

4 operations 3 paths 4 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Server
https://api.harborcompliance.com/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Harbor Compliance Licenses API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (apiKey). By default, every request must be authenticated.

  • apiKey — API key for authenticating partner requests. Obtain your API key from the Harbor Compliance developer portal.

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Licenses 4

Business license applications, renewals, and status tracking across jurisdictions.

GET
/licenses
Harbor Compliance List business licenses
listLicenses 5 params → 200401
POST
/licenses
Harbor Compliance Create a license application
createLicense body → 201400401
GET
/licenses/{licenseId}
Harbor Compliance Get a business license
getLicense 1 param → 200401404
POST
/licenses/{licenseId}/renew
Harbor Compliance Renew a business license
renewLicense 1 param body → 200400401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are License (12 properties), PaginationMeta (4 properties), LicenseCreate (4 properties), Error (3 properties). Each schema is shown below with its type and property counts.

LicenseCreate
object
Fields required to submit a new business license application.
4 properties 3 required
PaginationMeta
object
Pagination metadata included with list responses.
4 properties
License
object
A business license held by an entity in a specific jurisdiction.
12 properties 5 required
Error
object
Error response returned when a request fails.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harbor-compliance-licenses-api-openapi.yml Raw ↑

Other APIs Harbor Compliance publishes across the network.

Harbor Compliance Compliance Filings API
Harbor Compliance Entities API
Harbor Compliance Jurisdictions API
Harbor Compliance Orders API
Harbor Compliance Registered Agents API