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 Registered Agents API

Registered agent appointment and management for business entities.

Harbor Compliance Registered Agents 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 Registered Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and 1 JSON Schema.

This API exposes 3 operations across 2 paths, and defines 5 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.

3 operations 2 paths 5 schemas 2 GET1 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 Registered Agents 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 3

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

Registered Agents 3

Registered agent appointment and management for business entities.

GET
/registered-agents
Harbor Compliance List registered agent appointments
listRegisteredAgents 4 params → 200401
POST
/registered-agents
Harbor Compliance Appoint a registered agent
createRegisteredAgentAppointment body → 201400401
GET
/registered-agents/{agentId}
Harbor Compliance Get a registered agent appointment
getRegisteredAgent 1 param → 200401404

Schemas 5

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

RegisteredAgent
object
A registered agent appointment for a business entity in a state.
9 properties 4 required
RegisteredAgentCreate
object
Fields required to create a registered agent appointment.
3 properties 2 required
Address
object
A postal address.
6 properties 4 required
PaginationMeta
object
Pagination metadata included with list responses.
4 properties
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-registered-agents-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 Licenses API
Harbor Compliance Orders API