{ "openapi": "3.0.3", "info": { "title": "Harbor Compliance API", "version": "1.0.0", "description": "## Authorization\n\nThis API uses OAuth for authentication. When you request access, you will receive a client ID and a client secret. Two grant types are supported:\n\n- **Authorization Code** \u2014 Requires direct user interaction. You will also need to provide a redirect URI, which will receive the code your application exchanges for an access token.\n- **Password** \u2014 Does not require direct user intervention. Available to trusted apps only, as it involves handling user credentials directly.\n\n### Steps for the Authorization Code grant\n\n1. Direct the user to `/oauth/authorize` with your client ID, redirect URI, requested scopes, and state.\n\n *Example:* `/api/v1/oauth/authorize?response_type=code&client_id={client_id}&redirect_uri={redirect_uri}&scope=admin&state={state}`\n\n2. The user is authenticated and a code is returned to your redirect URI.\n\n *Example:* `https://example.com/your_redirect_uri.php?code={a_long_code}&state={the_state_you_used}`\n\n3. Use that code to request an access token from `/api/v1/oauth/access_token`. You will receive an access token and a refresh token (valid for up to 30 days; each refresh token can only be used once). See the examples below for full request details.\n\n4. When you need a new access token, use that refresh token to send a request to `/api/v1/oauth/access_token`. See the examples below for full request details.\n\n## Context based documentation\n\n The `/openapi` endpoint returns the openapi.yml specification document. When accessed with a valid access\n token, the response may include additional endpoints and schemas that are relevant to your specific API access.\n\n Alternatively, to see the full documentation available to you on this page,\n login first.\n" }, "security": [ { "Oauth2": [] } ], "tags": [ { "name": "OAuth2", "description": "OAuth2 authentication endpoints." }, { "name": "OpenAPI", "description": "The OpenAPI specification endpoint. Returns the API specification document, which may include additional context-specific endpoints when accessed with a valid access token.\n" }, { "name": "Accounts", "description": "An Account represents a customer organization. Accounts contain Companies, Users, and billing information. Most customers only have and use a single Account.\n" }, { "name": "Business Structures", "description": "A business structure is the legal entity classification of a business. Most customers use the basic legal structures: Limited Liability Companies, Corporations, and Nonprofit Corporations; the platform supports more complex legal structures such as PCs, PLLCs, LPs, LLPs, and more.\n" }, { "name": "Companies", "description": "A Company represents the legal entity of a business or nonprofit organization. As a side effect of adding a Company, the entity will automatically be enrolled in our Entity Manager module, which conducts secretary of state agency integration to harvest details on file with the state, such as detecting an entity's geographic footprint and monitoring good standing.\n" }, { "name": "Document Types", "description": "A Document Type is a category of document, such as Registered agent delivery - Delivered Service of Process or EIN Confirmation Letter.\n" }, { "name": "Filing Authorities", "description": "Filing Authorities are government agencies or bodies that manage business registrations, licensing, and other regulatory filings.\n" }, { "name": "Filing Methods", "description": "Filing Methods represent the different ways a filing can be submitted to a filing authority, such as online, mail, or in-person.\n" }, { "name": "Jurisdictions", "description": "A Jurisdiction is a geographic region. The platform supports jurisdictions worldwide and at every granularity (country, region, state/province, localities) to handle a variety of licensing requirements. However, many of our Services (such as Registered Agent Service) are established in the US and are expanding into other geographies based on client request volume.\n" }, { "name": "License Holder Types", "description": "(License Manager) A License Holder Type is the type of object who holds the license, such as a Company or an Individual.\n" }, { "name": "Licenses", "description": "(License Manager) A License is a government-issued authorization (from city, county, state, or other Filing Authority) that permits an individual or company to operate legally within a specific jurisdiction. The license may be a general business license, an industry-specific license, or permit only certain specialized activities.\n" }, { "name": "License Types", "description": "(License Manager) License Types classify licenses into categories based on their purpose, scope, or regulated activity.\n" }, { "name": "Orders", "description": "Order management endpoints" }, { "name": "Products", "description": "Products available to purchase include Annual Reports, Registered Agent, and Change of Registered Agent.\n" }, { "name": "Ref Licenses", "description": "Reference Licenses provide information about license requirements across jurisdictions and industries.\n" }, { "name": "Registered Agent Deliveries", "description": "As your registered agent, we receive documents from government agencies, service of process, and other official or government mail. Use the Registered Agent Deliveries resource to monitor for new documents and fetch details about your deliveries.\n" }, { "name": "Registration Status Groups", "description": "(Entity Manager) Registration Status Groups organize status into groupings such as Good Standing and Terminated.\n" }, { "name": "Registration Types", "description": "(Entity Manager) Registration Types denote whether the entity registration is Domestic, meaning home state, or Foreign, meaning out-of-state registration.\n" }, { "name": "Subscriptions", "description": "Subscriptions are recurring services billed periodically." }, { "name": "Subscription Statuses", "description": "Subscription Statuses represent the possible states of a subscription, such as Active, Invoiced, Overdue, or Cancelled.\n" }, { "name": "Record Books", "description": "A Record Book represents the corporate or LLC records for a company. It is created by enrolling a company in the Records Manager module. Record Books contain personnel (officers, directors, members, managers) depending on the business structure.\n" }, { "name": "Record Book Members", "description": "Members of a Record Book represent the individuals or companies that hold membership in an LLC or other entity structure. Members are managed through the Record Book's nested member endpoints.\n" }, { "name": "Record Book Officers", "description": "Officers of a Record Book represent individuals who hold officer titles (e.g. President, Secretary, Treasurer) in a corporation. Officers can only be added to corporation record books (Profit Corp or Nonprofit Corp).\n" }, { "name": "Record Book Directors", "description": "Directors of a Record Book represent individuals who hold director positions in a corporation. Directors can only be added to corporation record books (Profit Corp or Nonprofit Corp).\n" }, { "name": "Record Book Managers", "description": "Managers of a Record Book represent individuals who hold management roles in a manager-managed LLC. Managers can only be added to LLC record books where the company is configured as manager-managed.\n" } ], "servers": [ { "url": "https://www.harborcompliance.com/api/v1", "description": "Production API server" }, { "url": "https://sandbox-api.harborcompliance.com/api/v1", "description": "Sandbox API server (may be reset at any time)" } ], "paths": { "/accounts": { "get": { "summary": "List Accounts", "description": "Returns a paginated list of accounts the authenticated user has access to. Results can be filtered by name.\n", "tags": [ "Accounts" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "$ref": "#/components/parameters/AccountsIncludeParam" }, { "$ref": "#/components/parameters/AccountNameFilterParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } }, "post": { "summary": "Create Account", "description": "Creates a new account.", "tags": [ "Accounts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Account" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/accounts/{id}": { "get": { "summary": "View Account details", "description": "Returns details for a specific account by UUID.", "tags": [ "Accounts" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "$ref": "#/components/parameters/AccountsIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Account" } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } }, "patch": { "summary": "Update Account", "description": "Updates an existing account. Only provided fields will be updated.", "tags": [ "Accounts" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInput" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Account" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/products": { "get": { "summary": "List Products", "tags": [ "Products" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/oauth/authorize": { "get": { "summary": "OAuth2 Authorize", "security": [], "description": "Direct the user to this endpoint to initiate the OAuth2 authorization code flow. Once the user has logged in, they will be redirected to your specified redirect_uri with a code parameter.\n", "tags": [ "OAuth2" ], "parameters": [ { "name": "response_type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "code" ] }, "description": "OAuth2 response type. Must be `code`." }, { "$ref": "#/components/parameters/ClientId" }, { "$ref": "#/components/parameters/RedirectUri" }, { "$ref": "#/components/parameters/Scope" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string" }, "description": "An opaque value you can set to protect against CSRF attacks." } ], "responses": { "200": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/oauth/access_token": { "post": { "summary": "OAuth2 Access Token", "security": [], "tags": [ "OAuth2" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AuthorizationCodeGrant" }, { "$ref": "#/components/schemas/RefreshTokenGrant" }, { "$ref": "#/components/schemas/PasswordGrant" } ], "discriminator": { "propertyName": "grant_type", "mapping": { "authorization_code": "#/components/schemas/AuthorizationCodeGrant", "refresh_token": "#/components/schemas/RefreshTokenGrant", "password": "#/components/schemas/PasswordGrant" } } } } } }, "responses": { "200": { "description": "Token Granted", "content": { "application/json": { "schema": { "type": "object", "properties": { "token_type": { "type": "string", "example": "Bearer", "description": "The type of token issued." }, "expires_in": { "type": "integer", "example": 3599, "description": "Lifetime in seconds of the access token." }, "access_token": { "type": "string", "description": "The access token issued by the authorization server.", "example": "47|5deab0f47070047a2758644d8dcc6eed6b7ced295b1ea9cdee65940f22fa076823bc0d95f9bd27c4" }, "refresh_token": { "type": "string", "description": "The refresh token, which can be used to obtain new access tokens.", "example": "def502006f9e424c9a1a4bc38a0d2995139b49a008c63c28f8aa3147b7382416b86f5217af72cf014fb659db1cb0a00e055439175675bf3448517c4e26ca333799dd543cf363b1ef4499c323a226e8d57881769d60ca751fa3684a9353f11841e02010dc396c65922adce7edccf395ff2af761d785f7258e563ab2792bdb6b5003f4c3d5a64df220b61852244325147040e9270458e84415b3a6e5e191fe724e05f76f7163339e34e672a8a6844e517cb5760c6c168caa91e75b222a2499b99111a03a06edb7ea27abbb0baf9877084452fd778f2a5159da2b4c5f6296ad286407bbd0ac974434a95464ec7259bd966bc54bd4ce1f7b8238d5f8cebada00c3f69ea98f81c8f0d242105fd9093e09b03e9f831bb8aacb709a29934de73b5ae45285eebcf41c10cefce83b78b9566c2e836497d56822ae93cd49c495c75eeca71767430e85b9b1991406ba5d00db2f74d6f0c1a23045c5e5678a6ac47b8a9defbd39fdd9a1d8e2418425856ba06136c8246da842a58ba7c6f68cc1801a52d06bd9742e4ca22ab71650c80e3e47fbd9bca220f2f03539529f344b296538dc8d7e95d6536ef74aa73bba2405bd052c402950d424ac005df62aea9bb77da7f1b76ac3815331" } }, "required": [ "token_type", "expires_in", "access_token", "refresh_token" ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/document-types": { "get": { "summary": "List Document Types", "tags": [ "Document Types" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentType" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/companies": { "get": { "summary": "List Companies", "tags": [ "Companies" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "$ref": "#/components/parameters/CompaniesIncludeParam" }, { "$ref": "#/components/parameters/AccountFilterParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } }, "post": { "summary": "Add Company", "tags": [ "Companies" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Company" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/companies/{id}": { "get": { "summary": "View Company details", "tags": [ "Companies" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "$ref": "#/components/parameters/CompaniesIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Company" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } }, "patch": { "summary": "Edit Company", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyInput" } } } }, "tags": [ "Companies" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" } ], "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Company" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } }, "delete": { "summary": "Delete Company", "tags": [ "Companies" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" } ], "responses": { "204": { "description": "Deleted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/record-books": { "get": { "summary": "List Record Books", "description": "Returns a paginated list of record books for companies the authenticated user has access to. Optionally filter by company.\n", "tags": [ "Record Books" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "company_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Filter by company UUID" }, { "$ref": "#/components/parameters/RecordBooksIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RecordBook" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } }, "post": { "summary": "Create Record Book", "description": "Enrolls a company in the Records Manager module, creating a new record book. The company's business structure determines the entity type (LLC, Corp, Nonprofit Corp). For LLCs, you must specify whether the company is manager-managed or member-managed.\n", "tags": [ "Record Books" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordBookInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBook" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/record-books/{id}": { "get": { "summary": "View Record Book", "description": "Returns details for a specific record book by UUID.", "tags": [ "Record Books" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "$ref": "#/components/parameters/RecordBooksIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBook" } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "Record book not found" } } } }, "/record-books/{id}/members": { "get": { "summary": "List Record Book Members", "description": "Returns a paginated list of members for the specified record book.", "tags": [ "Record Book Members" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RecordBookMember" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access or record book not found" } } }, "post": { "summary": "Add Record Book Member", "description": "Adds a new member to the specified record book. Certificate number is auto-generated if not provided.", "tags": [ "Record Book Members" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordBookMemberInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBookMember" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access or record book not found" } } } }, "/record-books/{id}/members/{member_id}": { "delete": { "summary": "Remove Record Book Member", "description": "Removes a member from the specified record book.", "tags": [ "Record Book Members" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "name": "member_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID of the member to remove" } ], "responses": { "204": { "description": "Deleted" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access or record book not found" }, "404": { "description": "Member not found" } } } }, "/record-books/{id}/officers": { "get": { "summary": "List Record Book Officers", "description": "Returns a paginated list of officers for the specified record book.", "tags": [ "Record Book Officers" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RecordBookOfficer" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access or record book not found" } } }, "post": { "summary": "Add Record Book Officer", "description": "Adds a new officer to the specified record book. Officers can only be added to corporation record books (Profit Corp or Nonprofit Corp).\n", "tags": [ "Record Book Officers" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordBookOfficerInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBookOfficer" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access or record book not found" } } } }, "/record-books/{id}/officers/{officer_id}": { "delete": { "summary": "Remove Record Book Officer", "description": "Removes an officer from the specified record book.", "tags": [ "Record Book Officers" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "name": "officer_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID of the officer to remove" } ], "responses": { "204": { "description": "Deleted" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access or record book not found" }, "404": { "description": "Officer not found" } } } }, "/record-books/{id}/directors": { "get": { "summary": "List Record Book Directors", "description": "Returns a paginated list of directors for the specified record book.", "tags": [ "Record Book Directors" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RecordBookDirector" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access or record book not found" } } }, "post": { "summary": "Add Record Book Director", "description": "Adds a new director to the specified record book. Directors can only be added to corporation record books (Profit Corp or Nonprofit Corp).\n", "tags": [ "Record Book Directors" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordBookDirectorInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBookDirector" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access or record book not found" } } } }, "/record-books/{id}/directors/{director_id}": { "delete": { "summary": "Remove Record Book Director", "description": "Removes a director from the specified record book.", "tags": [ "Record Book Directors" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "name": "director_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID of the director to remove" } ], "responses": { "204": { "description": "Deleted" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access or record book not found" }, "404": { "description": "Director not found" } } } }, "/record-books/{id}/managers": { "get": { "summary": "List Record Book Managers", "description": "Returns a paginated list of managers for the specified record book.", "tags": [ "Record Book Managers" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RecordBookManager" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access or record book not found" } } }, "post": { "summary": "Add Record Book Manager", "description": "Adds a new manager to the specified record book. Managers can only be added to LLC record books where the company is configured as manager-managed.\n", "tags": [ "Record Book Managers" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordBookManagerInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBookManager" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access or record book not found" } } } }, "/record-books/{id}/managers/{manager_id}": { "delete": { "summary": "Remove Record Book Manager", "description": "Removes a manager from the specified record book.", "tags": [ "Record Book Managers" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "name": "manager_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID of the manager to remove" } ], "responses": { "204": { "description": "Deleted" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access or record book not found" }, "404": { "description": "Manager not found" } } } }, "/licenses": { "get": { "summary": "List Licenses", "tags": [ "Licenses" ], "parameters": [ { "$ref": "#/components/parameters/LicenseHolderTypeFilterParam" }, { "$ref": "#/components/parameters/CompanyFilterParam" }, { "$ref": "#/components/parameters/LicensesIncludeParam" }, { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRegistration" } }, "has_more": { "$ref": "#/components/schemas/HasMore" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/licenses/{id}": { "get": { "summary": "View License details", "tags": [ "Licenses" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "$ref": "#/components/parameters/LicensesIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CompanyRegistration" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/business-structures": { "get": { "summary": "List Business Structures", "tags": [ "Business Structures" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessStructure" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/registered-agent-deliveries": { "get": { "summary": "List all Registered Agent Deliveries (Documents).", "tags": [ "Registered Agent Deliveries" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "$ref": "#/components/parameters/AccountFilterParam" }, { "$ref": "#/components/parameters/RegisteredAgentDeliveriesIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RegisteredAgentDelivery" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/registered-agent-deliveries/{id}": { "get": { "summary": "View Registered Agent Delivery (Document). The account ID is required.", "tags": [ "Registered Agent Deliveries" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "$ref": "#/components/parameters/AccountFilterParam" }, { "$ref": "#/components/parameters/RegisteredAgentDeliveriesIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RegisteredAgentDelivery" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/registered-agent-deliveries/{id}/file": { "get": { "summary": "Download a specific Registered Agent Delivery (Document). The account ID is required.", "tags": [ "Registered Agent Deliveries" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" }, { "$ref": "#/components/parameters/AccountFilterParam" }, { "$ref": "#/components/parameters/RegisteredAgentDeliveriesIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/orders": { "post": { "summary": "Create a new order", "description": "Creates a new order for a product. You can create an order using either:\n- A preconfigured product ID (from AccountProductConfigs)\n- A product ID with a list of jurisdictions\nAllowed products:\n- Annual Report\n- Change of Registered Agent\n- Registered Agent\n", "tags": [ "Orders" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrderCreateWithProduct" }, { "$ref": "#/components/schemas/OrderCreateWithPreconfiguredProduct" } ] } } } }, "responses": { "200": { "description": "Order created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/orders/{id}": { "get": { "summary": "View an order", "description": "Retrieves details of a specific order by its UUID.", "tags": [ "Orders" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" } ], "responses": { "200": { "description": "Order retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } }, "patch": { "summary": "Edit an order", "description": "Updates an existing order. Only orders that have not been submitted and are for allowed products can be edited.\nYou can update the company and jurisdictions.\n", "tags": [ "Orders" ], "parameters": [ { "$ref": "#/components/parameters/UuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderInput" } } } }, "responses": { "200": { "description": "Order updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/subscriptions/cancellation_reasons": { "get": { "summary": "Get subscription cancellation reasons", "description": "Returns a list of valid reasons that can be used when cancelling a subscription.", "tags": [ "Subscriptions" ], "responses": { "200": { "description": "List of subscription cancellation reasons", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "Indicates if there are more results available", "example": false }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionCancellationReason" } } } } } } }, "401": { "description": "Unauthenticated" } } } }, "/subscriptions/cancel/{id}": { "post": { "summary": "Cancel a subscription", "description": "Cancels an active subscription by its ID.", "tags": [ "Subscriptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The ID of the subscription to cancel", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionInput" } } } }, "responses": { "200": { "description": "Subscription cancellation request received", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Subscription cancellation request received." } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access to this subscription" }, "404": { "description": "Subscription not found." } } } }, "/jurisdictions": { "get": { "summary": "List Jurisdictions", "tags": [ "Jurisdictions" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "name", "in": "query", "description": "Filter jurisdictions by name (partial match)", "required": false, "schema": { "type": "string" } }, { "name": "filter[registered_agent_only]", "in": "query", "description": "When set to a truthy value, limits results to US states and territories where Registered Agent service is available.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Jurisdiction" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" } } } }, "/filing-authorities": { "get": { "summary": "List Filing Authorities", "description": "Returns a paginated list of filing authorities. Results can be filtered by name.", "tags": [ "Filing Authorities" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "name", "in": "query", "description": "Filter filing authorities by name (partial match)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FilingAuthority" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" } } } }, "/license-holder-types": { "get": { "summary": "List License Holder Types", "description": "Returns a paginated list of license holder types. Results can be filtered by name.", "tags": [ "License Holder Types" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "name", "in": "query", "description": "Filter license holder types by name (partial match)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RefLicenseHolderType" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" } } } }, "/ref-licenses": { "get": { "summary": "List Ref Licenses", "description": "Returns a paginated list of reference licenses. Results can be filtered by name.", "tags": [ "Ref Licenses" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "$ref": "#/components/parameters/RefLicensesIncludeParam" }, { "name": "name", "in": "query", "description": "Filter licenses by name (partial match)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RefLicense" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" } } } }, "/license-types": { "get": { "summary": "List License Types", "description": "Returns a paginated list of license types. Results can be filtered by name.", "tags": [ "License Types" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "name", "in": "query", "description": "Filter license types by name (partial match)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RefLicenseType" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" } } } }, "/registration-types": { "get": { "summary": "List Registration Types", "description": "Returns a paginated list of registration types. Results can be filtered by name.", "tags": [ "Registration Types" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "name", "in": "query", "description": "Filter registration types by name (partial match)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RefRegistrationType" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" } } } }, "/registration-status-groups": { "get": { "summary": "List Registration Status Groups", "description": "Returns a paginated list of registration status groups. Results can be filtered by name.", "tags": [ "Registration Status Groups" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "name", "in": "query", "description": "Filter registration status groups by name (partial match)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RefRegistrationStatusGroup" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" } } } }, "/subscription-statuses": { "get": { "summary": "List Subscription Statuses", "description": "Returns a paginated list of subscription statuses. Results can be filtered by name.", "tags": [ "Subscription Statuses" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "name", "in": "query", "description": "Filter subscription statuses by name (partial match)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RefSubscriptionStatus" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" } } } }, "/openapi": { "get": { "summary": "Get OpenAPI specification", "description": "Returns the OpenAPI specification for this API as YAML.\n\nWhen called without authentication, returns the base public specification. When called with a valid access token, the response may include additional endpoints and schemas that are contextually relevant to the authenticated user.\n", "tags": [ "OpenAPI" ], "security": [ [], { "Oauth2": [] } ], "responses": { "200": { "description": "The OpenAPI specification document", "content": { "text/yaml": { "schema": { "type": "string", "description": "The complete OpenAPI 3.0 specification in YAML format. If authenticated, additional endpoints/schemas may be returned.\n" } } } } } } }, "/filing-methods": { "get": { "summary": "List Filing Methods", "description": "Returns a paginated list of filing methods. Results can be filtered by name.", "tags": [ "Filing Methods" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "name", "in": "query", "description": "Filter filing methods by name (partial match)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RefFilingMethod" } } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" } } } } }, "components": { "parameters": { "LimitParam": { "name": "limit", "in": "query", "description": "Maximum number of results per page", "required": false, "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, "PageParam": { "name": "page", "in": "query", "description": "Page number to retrieve", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 } }, "UuidPathParam": { "name": "id", "in": "path", "required": true, "description": "Resource UUID", "schema": { "type": "string", "format": "uuid" } }, "AccountFilterParam": { "name": "filter[account_id]", "in": "query", "description": "Filter the collection by the specific Account UUID. Value MUST be a canonical UUID string (8-4-4-4-12). Example: `123e4567-e89b-12d3-a456-426614174000`.", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "example": "123e4567-e89b-12d3-a456-426614174000" } }, "AccountNameFilterParam": { "name": "filter[name]", "in": "query", "description": "Filter accounts by exact name match.", "required": false, "schema": { "type": "string", "example": "Acme Corporation" } }, "LicenseHolderTypeFilterParam": { "name": "filter[license_holder_type]", "in": "query", "description": "Filter licenses by license holder type. Value can be either `company` or `individual`.", "required": false, "schema": { "type": "string", "enum": [ "company", "individual" ] } }, "AccountsIncludeParam": { "name": "include", "in": "query", "description": "Comma-separated list of related resources to include for accounts.", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "billing_address" ] } } }, "CompanyFilterParam": { "name": "filter[company_id]", "in": "query", "description": "Filter the collection by the specific Company UUID. Value MUST be a canonical UUID string (8-4-4-4-12). Example: `123e4567-e89b-12d3-a456-426614174000`.", "required": false, "schema": { "type": "string", "format": "uuid" } }, "CompaniesIncludeParam": { "name": "include", "in": "query", "description": "Comma-separated list of related resources to include for companies.", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "domicile", "business_structure", "principal_address", "mailing_address", "tax_classification", "accounting_method", "signers" ] } } }, "LicensesIncludeParam": { "name": "include", "in": "query", "description": "Comma-separated list of related resources to include for licenses.", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "account", "company", "individual_license_holder", "ref_jurisdiction", "ref_entity_override", "ref_filing_authority", "ref_license_holder_type", "ref_license", "ref_license_types", "ref_module", "ref_registration_type", "ref_registration_status_group" ] } } }, "RefLicensesIncludeParam": { "name": "include", "in": "query", "description": "Comma-separated list of related resources to include for reference licenses. `filing_authority` is only honored for users with the required permission; for users without it the include is silently ignored.", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "filing_authority" ] } } }, "RegisteredAgentDeliveriesIncludeParam": { "name": "include", "in": "query", "description": "Comma-separated list of related resources to include for Registered Agent Deliveries.", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "company", "ref_jurisdiction", "document_type" ] } } }, "RecordBooksIncludeParam": { "name": "include", "in": "query", "description": "Comma-separated list of related resources to include for record books.", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "company", "company.business_structure", "rm_ref_entity_type" ] } } }, "ClientId": { "name": "client_id", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The client id provided when you requested access to the API." }, "RedirectUri": { "name": "redirect_uri", "in": "query", "required": true, "schema": { "type": "string", "format": "uri" }, "description": "Where to send the code; the same URI you provided when you requested access to the api. Used when authorizing and when using a grant_type of authorization_code." }, "Scope": { "name": "scope", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "admin" ] }, "description": "Requested OAuth2 scopes. Currently only `admin` is supported." } }, "schemas": { "OAuthBaseGrant": { "type": "object", "description": "Base properties shared by all OAuth2 grant types.", "properties": { "grant_type": { "type": "string", "description": "The type of grant being requested." }, "client_id": { "type": "string", "description": "The client id provided when you requested access to the API." }, "client_secret": { "type": "string", "description": "The client secret provided when you requested access to the API." }, "scope": { "type": "string", "enum": [ "admin" ], "description": "Requested OAuth2 scopes. Currently only `admin` is supported." } }, "required": [ "grant_type", "client_id", "client_secret", "scope" ] }, "AuthorizationCodeGrant": { "allOf": [ { "$ref": "#/components/schemas/OAuthBaseGrant" }, { "type": "object", "description": "OAuth2 Authorization Code grant type request.", "properties": { "grant_type": { "type": "string", "enum": [ "authorization_code" ] }, "redirect_uri": { "type": "string", "format": "uri", "description": "Where to send the code; the same URI you provided when you requested access to the API. Required for authorization_code grant type." }, "code": { "type": "string", "description": "The authorization code received from the /oauth/authorize endpoint." } }, "required": [ "redirect_uri", "code" ] } ] }, "RefreshTokenGrant": { "allOf": [ { "$ref": "#/components/schemas/OAuthBaseGrant" }, { "type": "object", "description": "OAuth2 Refresh Token grant type request.", "properties": { "grant_type": { "type": "string", "enum": [ "refresh_token" ] }, "refresh_token": { "type": "string", "description": "The refresh token received from a previous /oauth/access_token request." } }, "required": [ "refresh_token" ] } ] }, "PasswordGrant": { "allOf": [ { "$ref": "#/components/schemas/OAuthBaseGrant" }, { "type": "object", "description": "OAuth2 Password (Resource Owner Password Credentials) grant type request.", "properties": { "grant_type": { "type": "string", "enum": [ "password" ] }, "username": { "type": "string", "description": "The user's username." }, "password": { "type": "string", "format": "password", "description": "The user's password." } }, "required": [ "username", "password" ] } ] }, "Account": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the account" }, "name": { "type": "string", "description": "Name of the account" }, "website": { "type": "string", "nullable": true, "description": "Website URL for the account" }, "billing_address": { "$ref": "#/components/schemas/Address" } }, "required": [ "id", "name" ] }, "AccountInput": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the account" }, "website": { "type": "string", "description": "Website URL for the account" }, "billing_address": { "$ref": "#/components/schemas/AddressInput" } }, "required": [ "name" ] }, "SubscriptionInput": { "type": "object", "properties": { "ref_subscription_cancellation_reason_id": { "type": "integer", "description": "ID of the reason for cancelling the subscription.\nUse the /subscriptions/cancellation_reasons endpoint to get the list of valid IDs.\n\nValid IDs:\n- 2: client_request_client_dissatisfied - Customer requested cancellation. Dissatisfied with service\n- 3: internal_decision_fired_client - Internal decision. Fired Client.\n- 4: billing_error - Billing error. Duplicate charge, failed charge, etc.\n- 5: other - Other reason not listed.\n- 6: unknown - Unknown reason. Client did not provide a reason.\n- 7: system_cancelled - System cancelled (non-payment or failed payment).\n- 8: client_request_changing_to_competitor - Client switching to competitor's service.\n- 9: client_request_changing_to_individual - Client switching to individual plan.\n- 10: client_request_terminating_registration - Client terminated state registration.\n- 11: client_request_doing_themselves - Client doing service themselves.\n", "example": 2 } }, "required": [ "ref_subscription_cancellation_reason_id" ] }, "SubscriptionCancellationReason": { "type": "object", "description": "A cancellation reason with id and name", "properties": { "id": { "type": "integer", "description": "The ID of the cancellation reason", "example": 2 }, "name": { "type": "string", "description": "The description of the cancellation reason", "example": "client_request_client_dissatisfied" } }, "required": [ "id", "name" ] }, "Company": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the company" }, "legal_name": { "type": "string", "description": "The company\u2019s exact legal name, including punctuation. We use this data for harvesting data from state agencies, so accuracy ensures the right match." }, "formation_date": { "type": "string", "format": "date", "nullable": true, "description": "Company formation date (YYYY-MM-DD)" }, "fiscal_year_end": { "type": "string", "nullable": true, "description": "Fiscal year end in MM/DD format, or null" }, "phone": { "type": "string", "nullable": true, "description": "Company phone number" }, "toll_free_phone": { "type": "string", "nullable": true, "description": "Company toll-free phone number" }, "email": { "type": "string", "nullable": true, "description": "Company email address" }, "fax": { "type": "string", "nullable": true, "description": "Company fax number" }, "no_fax": { "type": "boolean", "description": "Whether the company has no fax number" }, "website": { "type": "string", "nullable": true, "description": "Company website URL" }, "no_website": { "type": "boolean", "description": "Whether the company has no website" }, "mission": { "type": "string", "nullable": true, "description": "Company mission statement" }, "purpose_statement": { "type": "string", "nullable": true, "description": "Company purpose statement" }, "primary_product_or_service": { "type": "string", "nullable": true, "description": "Primary product or service of the company" }, "ein": { "type": "string", "nullable": true, "description": "Employer Identification Number" }, "domicile": { "$ref": "#/components/schemas/Jurisdiction" }, "business_structure": { "$ref": "#/components/schemas/BusinessStructure" }, "principal_address": { "$ref": "#/components/schemas/Address" }, "mailing_address": { "$ref": "#/components/schemas/Address" }, "tax_classification": { "$ref": "#/components/schemas/IrsTaxClassification" }, "accounting_method": { "$ref": "#/components/schemas/AccountingMethod" }, "signers": { "type": "array", "items": { "$ref": "#/components/schemas/User" }, "description": "Preferred signers for this company" } }, "required": [ "id", "legal_name" ] }, "BusinessStructure": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the business structure" }, "name": { "type": "string", "description": "Name of the business structure" } }, "required": [ "id", "name" ] }, "DocumentType": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the document type" }, "name": { "type": "string", "description": "Name of the document type" } }, "required": [ "id", "name" ] }, "CompanyRegistration": { "description": "Detailed license information.", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "id of the registration." }, "license_number": { "type": "string", "description": "Registration/license number." }, "license_holder_on_license": { "type": "string", "nullable": false, "description": "Legal name of the entity or individual holding the license." }, "license_name": { "type": "string", "nullable": false, "description": "The formal name of the license." }, "effective_date": { "type": "string", "format": "date", "description": "Registration effective date (YYYY-MM-DD)" }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "description": "Registration expiration date (YYYY-MM-DD), or null" }, "next_annual_report_due_date": { "type": "string", "format": "date", "nullable": true, "description": "Next annual report due date, or null" }, "registration_type": { "type": "string", "description": "The category of registration." }, "ref_module_id": { "type": "integer", "description": "The id of the module that generated this registration." }, "ref_license_holder_type_id": { "type": "integer", "description": "The id of the license holder type." }, "account": { "$ref": "#/components/schemas/Account" }, "company": { "$ref": "#/components/schemas/Company" }, "individual_license_holder": { "$ref": "#/components/schemas/User" }, "ref_jurisdiction": { "$ref": "#/components/schemas/Jurisdiction" }, "ref_filing_authority": { "$ref": "#/components/schemas/FilingAuthority" }, "ref_license_holder_type": { "$ref": "#/components/schemas/RefLicenseHolderType" }, "ref_license": { "$ref": "#/components/schemas/RefLicense" }, "ref_license_types": { "type": "array", "items": { "$ref": "#/components/schemas/RefLicenseType" } }, "ref_module": { "$ref": "#/components/schemas/RefModule" }, "ref_registration_type": { "$ref": "#/components/schemas/RefRegistrationType" }, "ref_registration_status_group": { "$ref": "#/components/schemas/RefRegistrationStatusGroup" } }, "required": [ "id", "license_number", "effective_date" ] }, "User": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the user" }, "first_name": { "type": "string", "description": "First name of the user" }, "middle_name": { "type": "string", "nullable": true, "description": "Middle name of the user" }, "last_name": { "type": "string", "description": "Last name of the user" }, "full_name": { "type": "string", "description": "Full name of the user" }, "email": { "type": "string", "description": "Email of the user" } } }, "Product": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the product" }, "name": { "type": "string", "description": "Display name of the product" } }, "required": [ "id", "name" ] }, "Address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "First line of the address" }, "address_line_2": { "type": "string", "nullable": true, "description": "Second line of the address (optional)" }, "locality": { "type": "string", "description": "City or locality" }, "postal_code": { "type": "string", "description": "Postal code" }, "administrative_area": { "$ref": "#/components/schemas/Jurisdiction" }, "country": { "$ref": "#/components/schemas/Jurisdiction" } }, "required": [ "address_line_1", "locality", "postal_code" ] }, "Jurisdiction": { "type": "object", "description": "A geographic jurisdiction (country, state/province, locality, etc.) returned in API responses. Always includes both id and name.\n", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000", "description": "ID of the jurisdiction" }, "name": { "type": "string", "description": "Name of the jurisdiction" } }, "required": [ "id", "name" ] }, "JurisdictionInput": { "type": "object", "description": "A jurisdiction reference for use in request bodies. Only the id is required; use the /jurisdictions endpoint to look up valid IDs.\n", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000", "description": "ID of the jurisdiction" } }, "required": [ "id" ] }, "IrsTaxClassification": { "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the IRS tax classification" }, "name": { "type": "string", "description": "Name of the tax classification" } }, "required": [ "id", "name" ] }, "AccountingMethod": { "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the accounting method" }, "name": { "type": "string", "description": "Name of the accounting method" } }, "required": [ "id", "name" ] }, "RecordBook": { "type": "object", "description": "A record book representing corporate or LLC records for a company.", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the record book" }, "company": { "$ref": "#/components/schemas/Company" }, "rm_ref_entity_type": { "$ref": "#/components/schemas/RmRefEntityType" } }, "required": [ "id" ] }, "RecordBookInput": { "type": "object", "properties": { "company": { "type": "object", "description": "The company to enroll in Records Manager", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the company" } }, "required": [ "id" ] }, "is_manager_managed": { "type": "boolean", "description": "Whether the LLC is manager-managed (true) or member-managed (false). Only applicable for LLC business structures; ignored for corporations. Defaults to false if omitted.\n" } }, "required": [ "company" ] }, "RmRefEntityType": { "type": "object", "description": "The record book entity type (e.g. LLC, Profit Corp, Nonprofit Corp).", "properties": { "name": { "type": "string", "description": "Name of the entity type" } }, "required": [ "name" ] }, "RecordBookMember": { "type": "object", "description": "A member of a record book.", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the member record" }, "certificate_number": { "type": "string", "description": "Membership certificate number" }, "member_name": { "type": "string", "description": "Name of the member" }, "date_of_transfer": { "type": "string", "format": "date", "nullable": true, "description": "Date of membership transfer (YYYY-MM-DD)" }, "percent_ownership": { "type": "number", "format": "float", "nullable": true, "description": "Ownership percentage (0.00001 to 1.0)" }, "amount_paid": { "type": "number", "format": "float", "nullable": true, "description": "Amount paid for membership" }, "member_user": { "$ref": "#/components/schemas/User" } }, "required": [ "id", "certificate_number", "member_name" ] }, "RecordBookMemberInput": { "type": "object", "properties": { "member": { "type": "object", "description": "The user to add as a member", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the user to add as a member" } }, "required": [ "id" ] }, "certificate_number": { "type": "string", "description": "Membership certificate number. Auto-generated if not provided." }, "percent_ownership": { "type": "number", "format": "float", "description": "Ownership percentage (0.00001 to 1.0)" }, "amount_paid": { "type": "number", "format": "float", "description": "Amount paid for membership" } }, "required": [ "member" ] }, "RecordBookOfficer": { "type": "object", "description": "An officer of a record book.", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the officer record" }, "user": { "$ref": "#/components/schemas/User" }, "title": { "type": "object", "description": "The officer's title (e.g. President, Secretary)", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "start_date": { "type": "string", "format": "date", "nullable": true, "description": "Officer start date (YYYY-MM-DD)" }, "end_date": { "type": "string", "format": "date", "nullable": true, "description": "Officer end date (YYYY-MM-DD)" } }, "required": [ "id" ] }, "RecordBookOfficerInput": { "type": "object", "properties": { "user": { "type": "object", "description": "The user to add as an officer", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the user to add as an officer" } }, "required": [ "id" ] }, "title": { "type": "object", "description": "The officer title to assign", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the officer title (e.g. President, Secretary)" } }, "required": [ "id" ] }, "start_date": { "type": "string", "format": "date", "description": "Officer start date (YYYY-MM-DD)" }, "end_date": { "type": "string", "format": "date", "description": "Officer end date (YYYY-MM-DD)" } }, "required": [ "user", "title" ] }, "RecordBookDirector": { "type": "object", "description": "A director of a record book.", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the director record" }, "user": { "$ref": "#/components/schemas/User" }, "position": { "type": "object", "description": "The director's position", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "start_date": { "type": "string", "format": "date", "nullable": true, "description": "Director start date (YYYY-MM-DD)" }, "end_date": { "type": "string", "format": "date", "nullable": true, "description": "Director end date (YYYY-MM-DD)" } }, "required": [ "id" ] }, "RecordBookDirectorInput": { "type": "object", "properties": { "user": { "type": "object", "description": "The user to add as a director", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the user to add as a director" } }, "required": [ "id" ] }, "position": { "type": "object", "description": "The director position to assign", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the director position" } }, "required": [ "id" ] }, "start_date": { "type": "string", "format": "date", "description": "Director start date (YYYY-MM-DD)" }, "end_date": { "type": "string", "format": "date", "description": "Director end date (YYYY-MM-DD)" } }, "required": [ "user", "position" ] }, "RecordBookManager": { "type": "object", "description": "A manager of a record book.", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the manager record" }, "user": { "$ref": "#/components/schemas/User" }, "manager_name": { "type": "string", "description": "Full name of the manager" }, "title": { "type": "string", "description": "The manager's title (e.g. Managing Member)" }, "start_date": { "type": "string", "format": "date", "nullable": true, "description": "Manager start date (YYYY-MM-DD)" }, "end_date": { "type": "string", "format": "date", "nullable": true, "description": "Manager end date (YYYY-MM-DD)" } }, "required": [ "id" ] }, "RecordBookManagerInput": { "type": "object", "properties": { "user": { "type": "object", "description": "The user to add as a manager", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the user to add as a manager" } }, "required": [ "id" ] }, "title": { "type": "string", "description": "The manager's title (e.g. Managing Member)" }, "start_date": { "type": "string", "format": "date", "description": "Manager start date (YYYY-MM-DD)" }, "end_date": { "type": "string", "format": "date", "description": "Manager end date (YYYY-MM-DD)" } }, "required": [ "user", "title" ] }, "FilingAuthority": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Filing Authority" }, "name": { "type": "string", "description": "Name of the Filing Authority" } }, "required": [ "id", "name" ] }, "RefFilingMethod": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Filing Method" }, "name": { "type": "string", "description": "Name of the Filing Method" } }, "required": [ "id", "name" ] }, "RefLicenseHolderType": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the License Holder Type" }, "name": { "type": "string", "description": "Name of the License Holder Type" } }, "required": [ "id", "name" ] }, "RefLicense": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the License" }, "name": { "type": "string", "description": "Name of the License" }, "entity_requirements": { "type": "string", "nullable": true, "description": "Entity-level requirements for the license. Only returned to users with the required permission." }, "legal_notes": { "type": "string", "nullable": true, "description": "Legal notes on the license. Only returned to users with the required permission." }, "notes": { "type": "string", "nullable": true, "description": "General notes on the license. Only returned to users with the required permission." }, "ownership_requirements": { "type": "string", "nullable": true, "description": "Ownership requirements for the license. Only returned to users with the required permission." }, "source": { "type": "string", "nullable": true, "description": "Source reference for the license information. Only returned to users with the required permission." }, "filing_authority": { "description": "Only returned when requested via `?include=filing_authority` by a user with the required permission.", "$ref": "#/components/schemas/FilingAuthority" } }, "required": [ "id", "name" ] }, "RefLicenseType": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the License Type" }, "name": { "type": "string", "description": "Name of the License Type" } }, "required": [ "id", "name" ] }, "RefModule": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Module" }, "name": { "type": "string", "description": "Name of the Module" }, "description": { "type": "string", "description": "Description of the Module" } }, "required": [ "id", "name" ] }, "RefRegistrationType": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Registration Type" }, "name": { "type": "string", "description": "Name of the Registration Type" } }, "required": [ "id", "name" ] }, "RefRegistrationStatusGroup": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Registration Status Group" }, "name": { "type": "string", "description": "Name of the Registration Status Group" } }, "required": [ "id", "name" ] }, "RefSubscriptionStatus": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Subscription Status" }, "name": { "type": "string", "description": "Name of the Subscription Status" } }, "required": [ "id", "name" ] }, "CompanyInput": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Account id to associate the company with" }, "business_structure": { "type": "object", "properties": { "id": { "type": "string", "description": "Business structure id" } }, "required": [ "id" ] }, "domicile": { "$ref": "#/components/schemas/JurisdictionInput" }, "principal_address": { "$ref": "#/components/schemas/AddressInput" }, "mailing_address": { "$ref": "#/components/schemas/AddressInput" }, "legal_name": { "type": "string", "description": "Legal name of the company" }, "formation_date": { "type": "string", "format": "date", "description": "Company formation date (YYYY-MM-DD)" }, "fiscal_year_end": { "type": "string", "description": "Fiscal year end in MM/DD format" }, "email": { "type": "string", "description": "Company email address" }, "phone": { "type": "string", "description": "Company phone number" }, "toll_free_phone": { "type": "string", "description": "Company toll-free phone number" }, "fax": { "type": "string", "description": "Company fax number" }, "no_fax": { "type": "boolean", "description": "Whether the company has no fax number" }, "website": { "type": "string", "description": "Company website URL" }, "no_website": { "type": "boolean", "description": "Whether the company has no website" }, "mission": { "type": "string", "description": "Company mission statement" }, "purpose_statement": { "type": "string", "description": "Company purpose statement" }, "primary_product_or_service": { "type": "string", "description": "Primary product or service of the company" }, "ein": { "type": "string", "description": "Employer Identification Number" }, "tax_classification": { "type": "object", "properties": { "id": { "type": "string", "description": "IRS tax classification id (UUID)" } }, "required": [ "id" ] }, "accounting_method": { "type": "object", "properties": { "id": { "type": "string", "description": "Accounting method id (UUID)" } }, "required": [ "id" ] }, "signers": { "type": "array", "description": "Array of user objects representing preferred signers. Each item must contain an id field with a valid user UUID.\n", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the user to set as a signer" } }, "required": [ "id" ] } } }, "required": [ "account_id", "business_structure", "domicile", "principal_address", "mailing_address", "legal_name" ] }, "AddressInput": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "First line of the address" }, "locality": { "type": "string", "description": "City or locality" }, "administrative_area": { "$ref": "#/components/schemas/JurisdictionInput" }, "postal_code": { "type": "string", "description": "Postal code" }, "country": { "$ref": "#/components/schemas/JurisdictionInput" } }, "required": [ "address_line_1", "locality", "administrative_area", "postal_code", "country" ] }, "RegisteredAgentDelivery": { "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the Registered Agent Delivery document" }, "name": { "type": "string", "description": "Name of the document" }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time the document was created" }, "is_downloadable": { "type": "boolean", "description": "Whether the document is available for download" }, "downloaded_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time the document was last downloaded, or null if never downloaded" }, "company": { "$ref": "#/components/schemas/Company" }, "jurisdiction": { "$ref": "#/components/schemas/Jurisdiction" }, "document_type": { "$ref": "#/components/schemas/DocumentType" } }, "required": [ "id", "name" ] }, "HasMore": { "type": "boolean", "description": "Indicates if there are more results available beyond the current page." }, "Order": { "type": "object", "required": [ "company", "product", "jurisdictions" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier for the order" }, "linked_to_order_id": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID of a related order, if applicable" }, "company": { "$ref": "#/components/schemas/Company" }, "product": { "$ref": "#/components/schemas/Product" }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/Jurisdiction" } } } }, "OrderInput": { "type": "object", "required": [ "company", "jurisdictions" ], "properties": { "company": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "The UUID of the company" } } }, "jurisdictions": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/JurisdictionInput" } }, "mark_ordered": { "type": "boolean", "default": false, "description": "Marks the Order as ordered without waiting for payment. This feature must be enabled on the Account the Order is for." } } }, "OrderCreateWithProduct": { "type": "object", "required": [ "company", "product", "jurisdictions" ], "properties": { "company": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "The UUID of the company" } } }, "product": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "The UUID of the product (Annual Report, Change of Registered Agent, or Registered Agent)" } } }, "jurisdictions": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/JurisdictionInput" } }, "linked_to_order_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Optional UUID of a related order" }, "mark_ordered": { "type": "boolean", "default": false, "description": "Marks the Order as ordered without waiting for payment. This feature must be enabled on the Account the Order is for." } } }, "OrderCreateWithPreconfiguredProduct": { "type": "object", "required": [ "company", "preconfigured_product" ], "properties": { "company": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "The UUID of the company" } } }, "preconfigured_product": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "The UUID of the preconfigured product (AccountProductConfig)" } } }, "mark_ordered": { "type": "boolean", "default": false, "description": "Marks the Order as ordered without waiting for payment. This feature must be enabled on the Account the Order is for." } } } }, "responses": { "BadRequest": { "description": "Invalid parameter format", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "example": "400" }, "code": { "type": "string", "example": "invalid_filter_format" }, "title": { "type": "string", "example": "Invalid Filter Value" } } } } } } } } } }, "securitySchemes": { "Oauth2": { "type": "oauth2", "x-default-scopes": [ "admin" ], "flows": { "authorizationCode": { "authorizationUrl": "/api/v1/oauth/authorize", "tokenUrl": "/api/v1/oauth/access_token", "x-usePkce": "no", "x-scalar-credentials-location": "body", "scopes": { "admin": "Full access to the Harbor Compliance API" } } } } } } }