{ "openapi": "3.1.0", "info": { "title": "Harbor Compliance API", "version": "3.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. Three grant types are supported:\n\n- **Client Credentials** \u2014 For server-to-server integrations. Exchange your client ID and secret at `/api/v3/oauth/access_token` with `grant_type=client_credentials`; no user interaction or redirect URI is involved. Clients created in the Developer Portal use this grant.\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 Client Credentials grant\n\n1. Create a client in the Developer Portal and store its client ID and client secret securely. The secret is shown only once; if you lose it, rotate it to get a new one.\n\n2. Request an access token from `/api/v3/oauth/access_token` with `grant_type=client_credentials`, your client ID and your client secret. Don't send a `scope`: the client's capabilities decide what it can access, and a request that includes a scope is rejected with `invalid_scope`.\n\n *Example:* `curl -X POST https://www.harborcompliance.com/api/v3/oauth/access_token -d grant_type=client_credentials -d client_id={client_id} -d client_secret={client_secret}`\n\n3. Send the access token in the `Authorization` header of your API requests.\n\n *Example:* `Authorization: Bearer {access_token}`\n\n4. No refresh token is issued. When the access token expires (see `expires_in` in the token response), request a new one the same way.\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/v3/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/v3/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/v3/oauth/access_token`. See the examples below for full request details.\n\n### API capabilities\n\nEach developer account is granted a set of **capabilities** that control which\nendpoints may be utilized. Capabilities are assigned when your account is\nprovisioned; contact Harbor Compliance to request changes.\n\nRetrieving data is included by default. Creating, updating, and deleting\nresources requires **additional capabilities** which Harbor Compliance must\nexplicitly grant to your account and which can then be applied to your OAuth\nclient.\n\nSome endpoints depend on **additional functionalities** beyond the standard\npartner surface. Contact Harbor Compliance to discuss access if you need\nexpanded functionality.\n\n## Rate limiting\n\nV3 resource endpoints use a **token-bucket** limiter keyed by OAuth **client ID**. Each request\nconsumes one token. OAuth token endpoints (`/oauth/*`) are excluded.\n\n**Default limits**\n\n- Burst capacity: 100 requests\n- Sustained rate: 60 requests per minute\n\n**Response headers** (on allowed and rate-limited responses)\n\n- `X-RateLimit-Limit` \u2014 maximum burst capacity\n- `X-RateLimit-Remaining` \u2014 tokens remaining after this request\n- `X-RateLimit-Reset` \u2014 Unix time when the bucket reaches full capacity\n\n**HTTP 429**\n\n- `Retry-After` header (seconds until a token is available)\n- JSON body: `error` (`rate_limit_exceeded`), `message`, `retry_after`\n\n**Client guidance**\n\n- Honor `Retry-After` before retrying\n- Monitor `X-RateLimit-Remaining` and throttle before hitting zero\n\n## Idempotency\n\nEndpoints marked as idempotent accept an optional `Idempotency-Key` header, so a request can be\nretried safely (for example after a timeout or dropped connection) without performing the work twice.\n\n**How it works**\n\n- Send a client-generated UUID in the `Idempotency-Key` header.\n- The first request with a key does the work. A retry with the same key and the identical request\n (same endpoint, query and body) returns the original status code and JSON body without doing the work\n again. Other response headers are not replayed.\n- A request without the header is always treated as new.\n- Keys are scoped to the calling OAuth client and user, so keys from different callers never collide.\n- Only successful (2xx) responses are kept. If the original request fails, the key is released and a\n retry is processed as new.\n- Keys are retained for 24 hours; after that, the same key is treated as a new request.\n\n**Errors**\n\n- `400` \u2014 the `Idempotency-Key` is not a valid UUID.\n- `409` \u2014 the key was already used with a different request, or a request with the same key is still\n being processed. For the latter, retry after a short delay to receive the original response.\n- Error bodies follow the standard shape: a `message` plus the details under `errors.idempotency_key`.\n\n**Client guidance**\n\n- Generate a new key for every distinct operation; reuse it only when retrying that same operation.\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": [] }, { "ClientCredentials": [] } ], "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": "Entity Registrations", "description": "(Entity Manager) An Entity Registration is a company's registration with a corporate registrar, such as a domestic formation or a foreign qualification. Entity Manager monitors these registrations for good standing and upcoming annual report deadlines. Read-only.\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": "Events", "description": "(License Manager) An Event is a compliance obligation tied to a license, such as an initial registration or a renewal filing. Events carry a due date, a frequency, an optional filing fee, and assignees.\n" }, { "name": "Orders", "description": "Order management endpoints" }, { "name": "Preconfigured Products", "description": "Preconfigured Products are pre-configured product bundles set up for an account, allowing streamlined ordering with predetermined product and jurisdiction selections.\n" }, { "name": "Products", "description": "Products available to purchase include Annual Reports, Registered Agent, and Change of Registered Agent.\n" }, { "name": "Projects", "description": "A Project is a unit of compliance work on an account, such as an annual report, a registered agent change, or a formation.\n" }, { "name": "Tasks", "description": "A Task is a unit of work within a Project, such as a single jurisdiction's filing. Tasks carry a client-facing status, a jurisdiction, and a due date.\n" }, { "name": "Comments", "description": "Comments are the conversation on a Project or one of its Tasks. Posting a comment notifies the account's followers. Attachments and status notes are not available through the API.\n" }, { "name": "Ref Filing Authorities", "description": "Reference Filing Authorities are the global catalog of government agencies and bodies that manage business registrations, licensing, and other regulatory filings. Clients holding the `ref-data-admin` capability can read the full record and create or update entries.\n" }, { "name": "Ref Filing Authority Statuses", "description": "Reference Filing Authority Statuses record operational status windows for a filing authority \u2014 or for a whole jurisdiction when no authority is set \u2014 such as an office closure affecting turnaround times. Mutating requests require the `ref-data-admin` and `write` capabilities.\n" }, { "name": "Ref Jurisdictions", "description": "Reference Jurisdictions are the geographic regions the platform operates against, from countries down to municipalities.\n" }, { "name": "Ref Licenses", "description": "Reference Licenses provide information about license requirements across jurisdictions and industries.\n" }, { "name": "Ref License Types", "description": "Reference License Types are the global catalog of license type classifications. Administering them requires the `ref-data-admin` capability; mutating requests also require `write`.\n" }, { "name": "Ref License License Types", "description": "Reference License License Types link a Ref License to one or more Ref License Types. Administering them requires the `ref-data-admin` capability; mutating requests also require `write`.\n" }, { "name": "Ref Project Types", "description": "Reference Project Types classify the kind of compliance work a Project represents, such as a Charitable Registration Filing or a Foreign Qualification.\n" }, { "name": "Ref Workflow Status Groups", "description": "Reference Workflow Status Groups organize workflow statuses into broad groupings such as New, Active, Completed, Cancelled, and On Hold.\n" }, { "name": "Ref Workflow Statuses", "description": "Reference Workflow Statuses are the granular statuses a workflow can be in, such as Waiting on Client Input or Filed.\n" }, { "name": "Ref Task Types", "description": "Reference Task Types classify the kind of work a Task represents, such as a Name Availability Search or Registered Agent change.\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": "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" }, { "name": "AR-IF State Answers", "description": "State-specific answers on a company's Annual Report/Information Form filing, addressed via the Workflow Information Form Detail that step belongs to. The writable fields are allow-listed per jurisdiction and grow over time \u2014 WY and DE are the first two.\n" }, { "name": "Record Book Share Classes", "description": "Share Classes of a Record Book describe a corporation's authorized and issued stock \u2014 the class and series, the authorized and issued counts, and the par value. They back the annual report's Shares step, which applies to domestic profit corporations. A share class cannot be deleted once shares have been issued to shareholders.\n" }, { "name": "Start a Business", "description": "Start a Business creates a new user, account, and company in a single atomic transaction, enabling a business to be started end-to-end through a single endpoint.\n" }, { "name": "Business Name Check", "description": "Business Name Check uses known company names and naming rules to report whether a business name is likely to be accepted or denied in a jurisdiction so alternative names can be proposed prior to filing if necessary. The appropriate Filing Authority always has final say on whether to accept or reject a requested name during the filing process.\n" } ], "servers": [ { "url": "https://www.harborcompliance.com/api/v3", "description": "Production API server" }, { "url": "https://sandbox-api.harborcompliance.com/api/v3", "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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "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" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}": { "get": { "summary": "View Account details", "description": "Returns details for a specific account by UUID.", "tags": [ "Accounts" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/AccountsIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Account" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "patch": { "summary": "Update Account", "description": "Updates an existing account. Only provided fields will be updated.", "tags": [ "Accounts" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" } ], "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" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies": { "get": { "summary": "List Companies", "tags": [ "Companies" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "$ref": "#/components/parameters/CompaniesIncludeParam" }, { "$ref": "#/components/parameters/CompanyNameFilterParam" } ], "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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "post": { "summary": "Add Company", "tags": [ "Companies" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" } ], "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" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}": { "get": { "summary": "View Company details", "tags": [ "Companies" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/CompaniesIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Company" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "patch": { "summary": "Edit Company", "tags": [ "Companies" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyInput" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Company" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "delete": { "summary": "Delete Company", "tags": [ "Companies" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" } ], "responses": { "204": { "description": "Deleted", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/licenses": { "get": { "summary": "List Licenses", "description": "Returns a paginated list of licenses for the specified company.", "tags": [ "Licenses" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$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" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- License Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "license_manager_access" } } } ] } } } }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "post": { "summary": "Create License", "description": "Creates a new license for the specified company under License Manager.\n**Custom license:** omit `ref_license` and supply at least one entry in `ref_license_types`.\n**Import from catalog:** supply `ref_license` to copy defaults (jurisdiction, filing authority, name, license types) from the catalog record. Explicitly provided fields override the corresponding catalog values.\nUse the `include` query parameter to embed related resources in the response.\n", "tags": [ "Licenses" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/LicensesIncludeParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRegistrationInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CompanyRegistration" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- License Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "license_manager_access" } } } ] } } } }, "422": { "description": "Request or entity validation failed" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/licenses/{license_uuid}": { "get": { "summary": "View License details", "tags": [ "Licenses" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" }, { "$ref": "#/components/parameters/LicensesIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CompanyRegistration" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- License Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "license_manager_access" } } } ] } } } }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "patch": { "summary": "Update License", "description": "Updates an existing company license under License Manager. Only provided fields will be updated. The `ref_license` catalog reference cannot be changed after creation.\nUse the `include` query parameter to embed related resources in the response.\n", "tags": [ "Licenses" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" }, { "$ref": "#/components/parameters/LicensesIncludeParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRegistrationUpdate" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CompanyRegistration" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- License Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "license_manager_access" } } } ] } } } }, "404": { "description": "License not found" }, "422": { "description": "Request or entity validation failed" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "delete": { "summary": "Delete License", "description": "Deletes an existing company license under License Manager. Managed licenses (those with managed compliance events) cannot be deleted.\n", "tags": [ "Licenses" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" } ], "responses": { "204": { "description": "Deleted", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- License Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "license_manager_access" } } } ] } } } }, "404": { "description": "License not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/licenses/{license_uuid}/events": { "get": { "summary": "List a license's Events", "description": "Returns a paginated list of a license's compliance events, ordered by due date. Use the `incomplete` query parameter to filter to incomplete or complete events only.\n", "tags": [ "Events" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" }, { "$ref": "#/components/parameters/EventsIncompleteFilterParam" }, { "$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/Event" } }, "has_more": { "$ref": "#/components/schemas/HasMore" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "License not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "post": { "summary": "Create Event", "description": "Creates a new compliance event under the specified license.\n", "tags": [ "Events" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Event" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "License not found" }, "422": { "description": "Request or entity validation failed" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/licenses/{license_uuid}/events/{event_uuid}": { "get": { "summary": "View Event details", "tags": [ "Events" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" }, { "$ref": "#/components/parameters/EventUuidPathParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Event" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "Event not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "patch": { "summary": "Update Event", "description": "Updates an existing compliance event. Only provided fields will be updated. Managed events cannot be edited; a completed event's filing fee cannot be changed.\n", "tags": [ "Events" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" }, { "$ref": "#/components/parameters/EventUuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventUpdate" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Event" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "Event not found" }, "422": { "description": "Request or entity validation failed" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "delete": { "summary": "Delete Event", "description": "Deletes an existing compliance event (soft delete). Managed and completed events cannot be deleted.\n", "tags": [ "Events" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" }, { "$ref": "#/components/parameters/EventUuidPathParam" } ], "responses": { "204": { "description": "Deleted", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "Event not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/registrations": { "get": { "summary": "List Entity Registrations", "description": "Returns a paginated list of the specified company's Entity Manager registrations, newest effective date first. License Manager licenses are not included (see the `licenses` endpoints for those), and DBA registrations are excluded.\nThe jurisdiction, filing authority and registration status group are always embedded in each registration; there is no `include` parameter for this endpoint.\n", "tags": [ "Entity Registrations" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$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/EntityRegistration" } }, "has_more": { "$ref": "#/components/schemas/HasMore" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "Company not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/registrations/{registration_uuid}": { "get": { "summary": "View Entity Registration details", "tags": [ "Entity Registrations" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RegistrationUuidPathParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EntityRegistration" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "Registration not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/projects": { "get": { "summary": "List Projects", "description": "Returns a paginated list of the account's projects.", "tags": [ "Projects" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "$ref": "#/components/parameters/ProjectsIncludeParam" }, { "name": "filter[year]", "in": "query", "required": false, "description": "Filter projects by year.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "has_more": { "$ref": "#/components/schemas/HasMore" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. The user does not have access to this account." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/projects/{project_uuid}": { "get": { "summary": "View Project details", "tags": [ "Projects" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/ProjectUuidPathParam" }, { "$ref": "#/components/parameters/ProjectsIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Project" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. The user does not have access to this account." }, "404": { "description": "Not Found. No project with that UUID exists for the account." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/projects/{project_uuid}/tasks": { "get": { "summary": "List Project tasks", "description": "Returns a paginated list of the project's tasks. Tasks removed from the package are excluded.", "tags": [ "Tasks" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/ProjectUuidPathParam" }, { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "$ref": "#/components/parameters/ProjectsIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } }, "has_more": { "$ref": "#/components/schemas/HasMore" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. The user does not have access to this account." }, "404": { "description": "Not Found. No project with that UUID exists for the account." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/projects/{project_uuid}/tasks/{task_uuid}": { "get": { "summary": "View Project task details", "description": "Returns a single task by UUID. A task the caller cannot see (removed from the package, or employee-only without the projects capability) returns 404.", "tags": [ "Tasks" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/ProjectUuidPathParam" }, { "$ref": "#/components/parameters/TaskUuidPathParam" }, { "$ref": "#/components/parameters/ProjectsIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Task" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. The user does not have access to this account." }, "404": { "description": "Not Found. No task with that UUID exists for the project." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/projects/{project_uuid}/comments": { "get": { "summary": "List Project comments", "description": "Returns a paginated list of comments on the project, newest first. Reading comments through the API does not mark them as read. The pinned comment is `?filter[is_pinned]=true`.\n", "tags": [ "Comments" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/ProjectUuidPathParam" }, { "$ref": "#/components/parameters/CommentIsPinnedFilterParam" }, { "$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/Comment" } }, "has_more": { "$ref": "#/components/schemas/HasMore" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. The user does not have access to this account." }, "404": { "description": "Not Found. The project does not exist or is not visible to the caller." }, "422": { "description": "Invalid query parameter." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "post": { "summary": "Create Project comment", "description": "Posts a comment on the project, attributed to the calling user. Returns 403 for a partner client (a machine client with no user), and for an account with in-app comments turned off unless the caller holds the `projects` capability. Sending `status`, `is_pinned` or `close_customer_comment_ids` without the `projects` capability is a 422.\n", "tags": [ "Comments" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/ProjectUuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Comment" } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden \u2014 missing capability, partner client, or in-app comments disabled" }, "404": { "description": "The project does not exist or is not visible to the caller" }, "422": { "description": "The request body failed validation" } } } }, "/accounts/{account_uuid}/projects/{project_uuid}/comments/{comment_uuid}": { "get": { "summary": "View Project comment", "description": "Returns a single comment by UUID. A comment that is not on this project returns 404.\n", "tags": [ "Comments" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/ProjectUuidPathParam" }, { "$ref": "#/components/parameters/CommentUuidPathParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Comment" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. The user does not have access to this account." }, "404": { "description": "Not Found. The project or the comment does not exist or is not visible to the caller." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/projects/{project_uuid}/tasks/{task_uuid}/comments": { "get": { "summary": "List Task comments", "description": "Returns a paginated list of comments on the task, newest first. Reading comments through the API does not mark them as read. The pinned comment is `?filter[is_pinned]=true`.\n", "tags": [ "Comments" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/ProjectUuidPathParam" }, { "$ref": "#/components/parameters/TaskUuidPathParam" }, { "$ref": "#/components/parameters/CommentIsPinnedFilterParam" }, { "$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/Comment" } }, "has_more": { "$ref": "#/components/schemas/HasMore" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. The user does not have access to this account." }, "404": { "description": "Not Found. The task does not exist or is not visible to the caller." }, "422": { "description": "Invalid query parameter." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "post": { "summary": "Create Task comment", "description": "Posts a comment on the task, attributed to the calling user. Returns 403 for a partner client (a machine client with no user), and for an account with in-app comments turned off unless the caller holds the `projects` capability. Sending `status`, `is_pinned` or `close_customer_comment_ids` without the `projects` capability is a 422.\n", "tags": [ "Comments" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/ProjectUuidPathParam" }, { "$ref": "#/components/parameters/TaskUuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Comment" } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden \u2014 missing capability, partner client, or in-app comments disabled" }, "404": { "description": "The task does not exist or is not visible to the caller" }, "422": { "description": "The request body failed validation" } } } }, "/accounts/{account_uuid}/projects/{project_uuid}/tasks/{task_uuid}/comments/{comment_uuid}": { "get": { "summary": "View Task comment", "description": "Returns a single comment by UUID. A comment that is not on this task returns 404.\n", "tags": [ "Comments" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/ProjectUuidPathParam" }, { "$ref": "#/components/parameters/TaskUuidPathParam" }, { "$ref": "#/components/parameters/CommentUuidPathParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Comment" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. The user does not have access to this account." }, "404": { "description": "Not Found. The task or the comment does not exist or is not visible to the caller." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/users/{user_uuid}/licenses": { "get": { "summary": "List User Licenses", "description": "Returns a paginated list of licenses for the specified user.", "tags": [ "Licenses" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/UserIdPathParam" }, { "$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" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "Account or user not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "post": { "summary": "Create User License", "description": "Creates a new license for the specified user under License Manager.\n**Custom license:** omit `ref_license` and supply at least one entry in `ref_license_types`.\n**Import from catalog:** supply `ref_license`; license types are copied from the catalog record and `ref_license_types` must be omitted.\nUse the `include` query parameter to embed related resources in the response.\n", "tags": [ "Licenses" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/UserIdPathParam" }, { "$ref": "#/components/parameters/LicensesIncludeParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRegistrationInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CompanyRegistration" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or user\n- License Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "license_manager_access" } } } ] } } } }, "404": { "description": "Account or user not found" }, "422": { "description": "Request or entity validation failed" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/users/{user_uuid}/licenses/{license_uuid}": { "get": { "summary": "View User License details", "tags": [ "Licenses" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/UserIdPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" }, { "$ref": "#/components/parameters/LicensesIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CompanyRegistration" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or user\n- License Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "license_manager_access" } } } ] } } } }, "404": { "description": "License not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "patch": { "summary": "Update User License", "description": "Updates an existing user license under License Manager. Only provided fields will be updated. The `ref_license` catalog reference cannot be changed after creation.\nUse the `include` query parameter to embed related resources in the response.\n", "tags": [ "Licenses" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/UserIdPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" }, { "$ref": "#/components/parameters/LicensesIncludeParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRegistrationUpdate" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CompanyRegistration" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or user\n- License Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "license_manager_access" } } } ] } } } }, "404": { "description": "License not found" }, "422": { "description": "Request or entity validation failed" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "delete": { "summary": "Delete User License", "description": "Deletes an existing user license under License Manager. Managed licenses (those with managed compliance events) cannot be deleted.\n", "tags": [ "Licenses" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/UserIdPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" } ], "responses": { "204": { "description": "Deleted", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or user\n- License Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "license_manager_access" } } } ] } } } }, "404": { "description": "License not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/users/{user_uuid}/licenses/{license_uuid}/events": { "get": { "summary": "List a license's Events", "description": "Returns a paginated list of a license's compliance events, ordered by due date. Use the `incomplete` query parameter to filter to incomplete or complete events only.\n", "tags": [ "Events" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/UserIdPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" }, { "$ref": "#/components/parameters/EventsIncompleteFilterParam" }, { "$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/Event" } }, "has_more": { "$ref": "#/components/schemas/HasMore" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "License not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "post": { "summary": "Create Event", "description": "Creates a new compliance event under the specified license.\n", "tags": [ "Events" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/UserIdPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Event" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "License not found" }, "422": { "description": "Request or entity validation failed" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/users/{user_uuid}/licenses/{license_uuid}/events/{event_uuid}": { "get": { "summary": "View Event details", "tags": [ "Events" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/UserIdPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" }, { "$ref": "#/components/parameters/EventUuidPathParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Event" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "Event not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "patch": { "summary": "Update Event", "description": "Updates an existing compliance event. Only provided fields will be updated. Managed events cannot be edited; a completed event's filing fee cannot be changed.\n", "tags": [ "Events" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/UserIdPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" }, { "$ref": "#/components/parameters/EventUuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventUpdate" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Event" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "Event not found" }, "422": { "description": "Request or entity validation failed" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "delete": { "summary": "Delete Event", "description": "Deletes an existing compliance event (soft delete). Managed and completed events cannot be deleted.\n", "tags": [ "Events" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/UserIdPathParam" }, { "$ref": "#/components/parameters/LicenseUuidPathParam" }, { "$ref": "#/components/parameters/EventUuidPathParam" } ], "responses": { "204": { "description": "Deleted", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "Event not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/registered-agent-deliveries": { "get": { "summary": "List Registered Agent Deliveries", "description": "Returns a paginated list of registered agent deliveries for the specified company.", "tags": [ "Registered Agent Deliveries" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "$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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/registered-agent-deliveries/{registered_agent_delivery_uuid}": { "get": { "summary": "View Registered Agent Delivery", "tags": [ "Registered Agent Deliveries" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RegisteredAgentDeliveryUuidPathParam" }, { "$ref": "#/components/parameters/RegisteredAgentDeliveriesIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RegisteredAgentDelivery" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/registered-agent-deliveries/{registered_agent_delivery_uuid}/file": { "get": { "summary": "Download Registered Agent Delivery file", "tags": [ "Registered Agent Deliveries" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RegisteredAgentDeliveryUuidPathParam" } ], "responses": { "200": { "description": "Success", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/record-books": { "get": { "summary": "List Record Books", "description": "Returns a paginated list of record books for the specified company.\n", "tags": [ "Record Books" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "$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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "post": { "summary": "Create Record Book", "description": "Enrolls the 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" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" } ], "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" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/record-books/{record_book_uuid}": { "get": { "summary": "View Record Book", "description": "Returns details for a specific record book by UUID.", "tags": [ "Record Books" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$ref": "#/components/parameters/RecordBooksIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBook" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "404": { "description": "Record book not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/record-books/{record_book_uuid}/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/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- Record book not found\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "post": { "summary": "Add Record Book Member", "description": "Adds a new member to the specified record book. Members can only be added to LLC record books.\n", "tags": [ "Record Book Members" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" } ], "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" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account, company, or record book\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "404": { "description": "Record book not found" }, "422": { "description": "Request body failed validation, or a business rule was violated." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/record-books/{record_book_uuid}/members/{member_uuid}": { "get": { "summary": "View Record Book Member", "description": "Returns details for a specific record book member by UUID.", "tags": [ "Record Book Members" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$ref": "#/components/parameters/MemberUuidPathParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBookMember" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- Record book not found\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "404": { "description": "Member not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "delete": { "summary": "Remove Record Book Member", "description": "Removes a member from the specified record book.", "tags": [ "Record Book Members" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$ref": "#/components/parameters/MemberUuidPathParam" } ], "responses": { "204": { "description": "Deleted", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account, company, or record book\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "404": { "description": "Member not found" }, "422": { "description": "Request body failed validation, or a business rule was violated." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/record-books/{record_book_uuid}/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/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- Record book not found\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "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/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" } ], "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" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account, company, or record book\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "404": { "description": "Record book not found" }, "422": { "description": "Request body failed validation, or a business rule was violated." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/record-books/{record_book_uuid}/officers/{officer_uuid}": { "get": { "summary": "View Record Book Officer", "description": "Returns details for a specific record book officer by UUID.", "tags": [ "Record Book Officers" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$ref": "#/components/parameters/OfficerUuidPathParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBookOfficer" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- Record book not found\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "404": { "description": "Officer not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "delete": { "summary": "Remove Record Book Officer", "description": "Removes an officer from the specified record book.", "tags": [ "Record Book Officers" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$ref": "#/components/parameters/OfficerUuidPathParam" } ], "responses": { "204": { "description": "Deleted", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account, company, or record book\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "404": { "description": "Officer not found" }, "422": { "description": "Request body failed validation, or a business rule was violated." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/record-books/{record_book_uuid}/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/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- Record book not found\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "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/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" } ], "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" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account, company, or record book\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "404": { "description": "Record book not found" }, "422": { "description": "Request body failed validation, or a business rule was violated." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/record-books/{record_book_uuid}/directors/{director_uuid}": { "get": { "summary": "View Record Book Director", "description": "Returns details for a specific record book director by UUID.", "tags": [ "Record Book Directors" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$ref": "#/components/parameters/DirectorUuidPathParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBookDirector" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- Record book not found\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "404": { "description": "Director not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "delete": { "summary": "Remove Record Book Director", "description": "Removes a director from the specified record book.", "tags": [ "Record Book Directors" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$ref": "#/components/parameters/DirectorUuidPathParam" } ], "responses": { "204": { "description": "Deleted", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account, company, or record book\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "404": { "description": "Director not found" }, "422": { "description": "Request body failed validation, or a business rule was violated." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/record-books/{record_book_uuid}/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/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- Record book not found\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "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/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" } ], "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" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account, company, or record book\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "404": { "description": "Record book not found" }, "422": { "description": "Request body failed validation, or a business rule was violated." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/record-books/{record_book_uuid}/managers/{manager_uuid}": { "get": { "summary": "View Record Book Manager", "description": "Returns details for a specific record book manager by UUID.", "tags": [ "Record Book Managers" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$ref": "#/components/parameters/ManagerUuidPathParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBookManager" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- Record book not found\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "404": { "description": "Manager not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "delete": { "summary": "Remove Record Book Manager", "description": "Removes a manager from the specified record book.", "tags": [ "Record Book Managers" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$ref": "#/components/parameters/ManagerUuidPathParam" } ], "responses": { "204": { "description": "Deleted", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account, company, or record book\n- Records Manager is not enabled for this account (`feature_not_enabled`)\n", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string" }, "feature": { "type": "string", "example": "records_manager_access" } } } ] } } } }, "404": { "description": "Manager not found" }, "422": { "description": "Request body failed validation, or a business rule was violated." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/workflow-information-form-details/{wifd_uuid}/state-answers": { "get": { "summary": "Get AR-IF State Answers", "description": "Returns the state-specific AR-IF answers for the given Workflow Information Form Detail, transformed. `data` is `null` when no answers have been submitted for this detail yet \u2014 that is a valid, expected state, not an error.\n", "tags": [ "AR-IF State Answers" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/WifdUuidPathParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ArIfStateAnswer" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "404": { "description": "Workflow Information Form Detail not found, or not owned by this account/company" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "post": { "summary": "Create or Update AR-IF State Answers", "description": "Upsert \u2014 creates the state-answers row for this Workflow Information Form Detail when absent, updates it when present. Only the fields allow-listed for the detail's jurisdiction may be sent; any other key is rejected with a field-keyed 422, never silently dropped or passed through. `workflow_information_form_detail_id` and `ref_jurisdiction_id` are always resolved from the path and cannot be reassigned by the payload. Sparse payloads are valid \u2014 omitting a key never fails.\n\nWyoming's `wyoming_business_has_assets_or_employees` gate is always client-answered: the endpoint never derives it, and `null`/absent is the expected value for a migrated row. Sending it as `false` alongside any populated Wyoming line item in the same request is rejected, since that combination would otherwise silently null out the line items on save.\n", "tags": [ "AR-IF State Answers" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/WifdUuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArIfStateAnswerInput" } } } }, "responses": { "200": { "description": "Created or updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ArIfStateAnswer" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access or lacks required capability" }, "404": { "description": "Workflow Information Form Detail not found, or not owned by this account/company" }, "422": { "description": "Validation failed. Possible causes:\n- A field outside the jurisdiction's allow-list was sent\n- wyoming_business_has_assets_or_employees was false alongside populated line items\n- delaware_nature_of_business is 'Other' with an empty or overlong delaware_other_nature_of_business\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/record-books/{record_book_uuid}/share-classes": { "get": { "summary": "List Record Book Share Classes", "description": "Returns a paginated list of share classes for the specified record book.", "tags": [ "Record Book Share Classes" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$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/RecordBookShareClass" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account or company\n- The record book uuid is unknown, or is on an account the caller cannot reach\n" }, "404": { "description": "The record book is reachable by the caller but is not on the company in the path \u2014 a record book on a sibling company of the same account is a 404. An unknown uuid is a 403, because the policy denies before the lookup runs.\n" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "post": { "summary": "Add Record Book Share Class", "description": "Adds a share class to the specified record book. No field is defaulted server-side: `no_series`, `has_unlimited_authorized_shares` and `no_par_value` are each required, because an unset flag does not read as false and an unset flag whose partner field is also absent would otherwise save an incomplete share class.\n", "tags": [ "Record Book Share Classes" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordBookShareClassInput" } } } }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBookShareClass" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account, company, or record book\n- The record book uuid is unknown \u2014 the policy denies before the lookup runs,\n so this is a 403 and not a 404\n" }, "404": { "description": "The record book is reachable by the caller but is not on the company in the path \u2014 a record book on a sibling company of the same account is a 404. An unknown uuid is a 403, because the policy denies before the lookup runs.\n" }, "422": { "description": "The share class failed validation. Field-keyed, and includes both the missing required flags and the paired-flag rules: a series without `no_series` false, a par value alongside `no_par_value` true, `shares_issued` greater than `shares_authorized`, or a null `par_value` with a null `no_par_value`. A rejected share class is not partially written \u2014 no row is created.\n" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/companies/{company_uuid}/record-books/{record_book_uuid}/share-classes/{share_class_uuid}": { "get": { "summary": "View Record Book Share Class", "description": "Returns a single share class belonging to the specified record book.", "tags": [ "Record Book Share Classes" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$ref": "#/components/parameters/ShareClassUuidPathParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBookShareClass" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account, company, or record book\n- The record book uuid is unknown \u2014 the policy denies before the lookup runs,\n so this is a 403 and not a 404\n" }, "404": { "description": "The share class is not on the record book in the path, or the record book is reachable by the caller but is not on the company in the path. An unknown record book uuid is a 403.\n" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "patch": { "summary": "Update Record Book Share Class", "description": "Updates a share class. Partial, but the class's validation rules are re-checked against the merged record, so a change that unpairs a flag from its partner field is rejected.\n", "tags": [ "Record Book Share Classes" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$ref": "#/components/parameters/ShareClassUuidPathParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordBookShareClassUpdateInput" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordBookShareClass" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account, company, or record book\n- The record book uuid is unknown \u2014 the policy denies before the lookup runs,\n so this is a 403 and not a 404\n" }, "404": { "description": "The share class is not on the record book in the path, or the record book is reachable by the caller but is not on the company in the path. An unknown record book uuid is a 403.\n" }, "422": { "description": "The updated share class failed validation. Field-keyed." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "delete": { "summary": "Remove Record Book Share Class", "description": "Removes a share class from the specified record book. A share class that has shareholders cannot be deleted \u2014 reassign or remove them first.\n", "tags": [ "Record Book Share Classes" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/CompanyUuidPathParam" }, { "$ref": "#/components/parameters/RecordBookUuidPathParam" }, { "$ref": "#/components/parameters/ShareClassUuidPathParam" } ], "responses": { "204": { "description": "Deleted", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Possible causes:\n- User does not have access to this account, company, or record book\n- The record book uuid is unknown \u2014 the policy denies before the lookup runs,\n so this is a 403 and not a 404\n" }, "404": { "description": "The share class is not on the record book in the path, or the record book is reachable by the caller but is not on the company in the path. An unknown record book uuid is a 403.\n" }, "422": { "description": "The share class could not be deleted because shares have already been issued to shareholders.\n" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/jurisdictions": { "get": { "summary": "List Jurisdictions for Account", "description": "Returns a paginated list of jurisdictions relevant to the specified account's licenses and registrations.\n", "tags": [ "Jurisdictions" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "name", "in": "query", "description": "Filter jurisdictions 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/Jurisdiction" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/filing-authorities": { "get": { "summary": "List Filing Authorities for Account", "description": "Returns a paginated list of filing authorities relevant to the specified account's licenses and registrations.\n", "tags": [ "Filing Authorities" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/license-types": { "get": { "summary": "List License Types for Account", "description": "Returns a paginated list of license types relevant to the specified account's licenses and registrations.\n", "tags": [ "License Types" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/preconfigured-products": { "get": { "summary": "List Preconfigured Products for Account", "description": "Returns a paginated list of preconfigured product bundles available for the specified account.\n", "tags": [ "Preconfigured Products" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$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/PreconfiguredProduct" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/start-a-business": { "get": { "summary": "List Start a Business Requests", "description": "Returns a paginated list of start-a-business requests made by the authenticated user.\n", "tags": [ "Start a Business" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "$ref": "#/components/parameters/StartBusinessRequestsIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StartBusinessRequest" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "post": { "summary": "Start a Business", "description": "Creates a new user, account, and company, and places a formation order for the company's business structure, all in a single atomic transaction. The formation product (LLC or Corporation) is inferred from `business_structure`.\n\nThis endpoint is idempotent: send an `Idempotency-Key` header to retry safely. See the Idempotency section of this documentation.\n", "tags": [ "Start a Business" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKeyHeaderParam" }, { "$ref": "#/components/parameters/StartBusinessRequestsIncludeParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartBusinessInput" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StartBusinessRequest" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "description": "The request body is not valid JSON.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartBusinessErrorMessage" } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartBusinessErrorMessage" } } } }, "403": { "description": "The client lacks the `write` capability, or `account.partner_id` names a partner the caller can't act for.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartBusinessErrorMessage" } } } }, "404": { "description": "A reference id did not resolve to an existing record: `business_structure.id`, `domicile.id`, an address's `administrative_area.id` or `country.id`, an officer's `officer_title.id`, or a director's `director_position.id`.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartBusinessErrorMessage" } } } }, "409": { "$ref": "#/components/responses/IdempotencyConflict" }, "422": { "description": "The request body failed validation, or a business rule was violated.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartBusinessValidationError" }, "examples": { "schema": { "summary": "Request does not match the schema", "value": { "message": "The given data was invalid.", "errors": { "company": { "legal_name": { "message": "Minimum string length is 1, found 0" } } } } }, "businessRule": { "summary": "Business rule violated", "value": { "message": "The given data was invalid.", "errors": { "llc_personnel_required": [ "An LLC must have at least one member or manager." ] } } }, "record": { "summary": "Rejected when saving a record", "value": { "message": "The given data was invalid.", "errors": { "company": { "legal_name": [ "This name is missing a business entity identifier (for example LLC, Corp or Inc) and is likely to be denied." ] } } } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/start-a-business/{start_business_request_uuid}": { "get": { "summary": "Get Start a Business Request", "description": "Returns a single start-a-business request made by the authenticated user.", "tags": [ "Start a Business" ], "parameters": [ { "$ref": "#/components/parameters/StartBusinessRequestUuidPathParam" }, { "$ref": "#/components/parameters/StartBusinessRequestsIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StartBusinessRequest" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Start-a-business request not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/start-a-business/{start_business_request_uuid}/status": { "get": { "summary": "Get Start a Business Status", "description": "Returns just the status of the business formation, for polling. It is \"Processing\" while the formation is being set up right after the request, then reflects the formation's progress. Poll until it is no longer \"Processing\".\n", "tags": [ "Start a Business" ], "parameters": [ { "$ref": "#/components/parameters/StartBusinessRequestUuidPathParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StartBusinessStatus" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Start-a-business request not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/business-structures": { "get": { "summary": "List Business Structures", "tags": [ "Business Structures" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "filter[start_a_business_only]", "in": "query", "description": "When true, only return business structures that can be used to place a formation order via POST /start-a-business (LLC and Corporation).\n", "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/BusinessStructure" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "422": { "description": "filter[start_a_business_only] was present but not a recognized boolean value." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/products": { "get": { "summary": "List Products", "description": "Returns a paginated list of products orderable via `POST /accounts/{account_uuid}/orders`\n(Annual Report, Change of Registered Agent, Registered Agent, LLC Formation Package,\nCorporation Formation Package).\n", "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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-filing-authorities": { "get": { "summary": "List Ref Filing Authorities", "description": "Returns a paginated list of reference filing authorities. Results can be filtered by name.", "tags": [ "Ref 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/RefFilingAuthority" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-filing-authorities/{ref_filing_authority_uuid}": { "get": { "summary": "Get Ref Filing Authority", "description": "Returns a single reference filing authority by UUID.", "tags": [ "Ref Filing Authorities" ], "parameters": [ { "name": "ref_filing_authority_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RefFilingAuthority" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "404": { "description": "Reference filing authority not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-filing-authority-statuses": { "get": { "summary": "List Ref Filing Authority Statuses", "description": "Returns a paginated list of reference filing authority statuses. Results can be filtered by the UUID of any related reference record. Use the `include` query parameter to sideload related objects.\n", "tags": [ "Ref Filing Authority Statuses" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "$ref": "#/components/parameters/RefFilingAuthorityStatusIncludeParam" }, { "$ref": "#/components/parameters/RefFilingAuthorityStatusAuthorityFilterParam" }, { "$ref": "#/components/parameters/RefFilingAuthorityStatusJurisdictionFilterParam" }, { "$ref": "#/components/parameters/RefFilingAuthorityStatusGroupFilterParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RefFilingAuthorityStatus" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "422": { "description": "Request validation failed" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-filing-authority-statuses/{ref_filing_authority_status_uuid}": { "get": { "summary": "Get Ref Filing Authority Status", "description": "Returns a single reference filing authority status by UUID.", "tags": [ "Ref Filing Authority Statuses" ], "parameters": [ { "$ref": "#/components/parameters/RefFilingAuthorityStatusUuidPathParam" }, { "$ref": "#/components/parameters/RefFilingAuthorityStatusIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RefFilingAuthorityStatus" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "404": { "description": "Reference filing authority status not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-jurisdictions": { "get": { "summary": "List Ref Jurisdictions", "description": "Returns a paginated list of reference jurisdictions. This is the global reference set \u2014 jurisdictions custom to an account are not included; those are served by /accounts/{account_uuid}/jurisdictions. Use the returned ids when referencing a jurisdiction on other endpoints, such as the company domicile or an address administrative area on Start a Business. Results can be filtered by name.\n", "tags": [ "Ref 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 true, limits the results to the jurisdictions where Registered Agent Service is available (the 50 states, the District of Columbia, and Puerto Rico).\n", "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/RefJurisdiction" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "422": { "description": "filter[registered_agent_only] was present but not a recognized boolean value." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-jurisdictions/{ref_jurisdiction_uuid}": { "get": { "summary": "Get Ref Jurisdiction", "description": "Returns a single reference jurisdiction by UUID.", "tags": [ "Ref Jurisdictions" ], "parameters": [ { "name": "ref_jurisdiction_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RefJurisdiction" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "404": { "description": "Reference jurisdiction not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/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" }, { "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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-licenses/{ref_license_uuid}": { "get": { "summary": "Get Ref License", "description": "Returns a single reference license by UUID.", "tags": [ "Ref Licenses" ], "parameters": [ { "name": "ref_license_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RefLicense" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "404": { "description": "Reference license not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-license-types": { "get": { "summary": "List Ref License Types", "description": "Returns a paginated list of global reference license types. Results can be filtered by name.", "tags": [ "Ref 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/RefLicenseTypeDetail" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-license-types/{ref_license_type_uuid}": { "get": { "summary": "Get Ref License Type", "description": "Returns a single global reference license type by UUID.", "tags": [ "Ref License Types" ], "parameters": [ { "name": "ref_license_type_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RefLicenseTypeDetail" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "404": { "description": "Reference license type not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-license-license-types": { "get": { "summary": "List Ref License License Types", "description": "Returns a paginated list of Ref License / Ref License Type links. Results can be filtered by ref_license_id and/or ref_license_type_id.\n", "tags": [ "Ref License License Types" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "ref_license_id", "in": "query", "description": "Filter by the UUID of the linked Ref License", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "ref_license_type_id", "in": "query", "description": "Filter by the UUID of the linked Ref License Type", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RefLicenseLicenseTypeDetail" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "404": { "description": "ref_license_id or ref_license_type_id filter did not match any record" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-license-license-types/{ref_license_license_type_uuid}": { "get": { "summary": "Get Ref License License Type", "description": "Returns a single Ref License / Ref License Type link by UUID.", "tags": [ "Ref License License Types" ], "parameters": [ { "name": "ref_license_license_type_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RefLicenseLicenseTypeDetail" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "404": { "description": "Reference license license type not found" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-licenses/event-types": { "get": { "summary": "List License Ref Event Types", "description": "Returns a paginated list of license ref event types (e.g. Initial Registration, License Renewal). Results can be filtered by name.", "tags": [ "Ref Licenses" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "name", "in": "query", "description": "Filter event 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/RefEventType" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-project-types": { "get": { "summary": "List Ref Project Types", "description": "Returns a paginated list of reference project types (e.g. Charitable Registration Filing Project, Foreign Qualification Project).", "tags": [ "Ref Project 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/RefProjectType" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-workflow-status-groups": { "get": { "summary": "List Ref Workflow Status Groups", "description": "Returns a paginated list of reference workflow status groups (e.g. New, Active, Completed).", "tags": [ "Ref Workflow Status Groups" ], "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/RefWorkflowStatusGroup" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-workflow-statuses": { "get": { "summary": "List Ref Workflow Statuses", "description": "Returns a paginated list of reference workflow statuses (e.g. Waiting on Client Input, Filed).", "tags": [ "Ref Workflow Statuses" ], "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/RefWorkflowStatus" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-task-types": { "get": { "summary": "List Ref Task Types", "description": "Returns a paginated list of reference task types (e.g. Name Availability Search, Registered Agent).", "tags": [ "Ref Task 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/RefTaskType" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-officer-titles": { "get": { "summary": "List Officer Titles", "description": "Returns a paginated list of officer titles (e.g. President, Secretary). Results can be filtered by name.", "tags": [ "Record Book Officers" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "name", "in": "query", "description": "Filter officer titles 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/RmRefOfficerTitle" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/ref-director-positions": { "get": { "summary": "List Director Positions", "description": "Returns a paginated list of director positions (e.g. Chair, Director). Results can be filtered by name.", "tags": [ "Record Book Directors" ], "parameters": [ { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "name": "name", "in": "query", "description": "Filter director positions 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/RmRefDirectorPosition" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/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" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have API access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/orders": { "get": { "summary": "List Orders", "description": "Returns a paginated list of orders for the given account.\n\nDefault pagination: `limit=20`, maximum `limit=100`, sorted by `created` ascending.\nUse the `include` query parameter to embed related resources in each order.\n", "tags": [ "Orders" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/LimitParam" }, { "$ref": "#/components/parameters/PageParam" }, { "$ref": "#/components/parameters/OrdersIncludeParam" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/HasMore" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden - User does not have access" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "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 (any account-owned AccountProductConfig)\n- A product ID with a list of jurisdictions (allowed products only):\n - Annual Report\n - Change of Registered Agent\n - Registered Agent\n - LLC Formation Package\n - Corporation Formation Package\n\nAuthorization rules:\n- `mark_ordered: true` \u2014 the account must have Order Now, Pay Later enabled\n- `mark_purchased: true` \u2014 the caller must be a billing admin\n- `suppress_company_onboarding: true` \u2014 employee only\n\nRegistered Agent orders may include an optional `product_detail` object to\ndesignate the order as a BOC-3 special agency appointment and supply the carrier's\nFMCSA and DOT numbers. The object takes effect only when it carries\n`special_agency_type`; without it the object is ignored for any product. When\n`special_agency_type` is present the product must be Registered Agent, and both\nnumbers are required. The numbers are stored as order data and shown to\nfulfillment staff, and echoed back in the response under `product_detail`.\n\nThe **200** response always embeds `company`, `ref_product`, `order_jurisdictions`,\nand `linked_to_order` (when applicable), regardless of the `include` query parameter.\n", "tags": [ "Orders" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" } ], "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" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Common causes:\n- Disallowed product (`This product cannot be ordered via the API.`)\n- Company or preconfigured product not found for this account\n- `mark_ordered: true` when Order Now, Pay Later is not enabled\n- `mark_purchased: true` without billing admin access\n- `suppress_company_onboarding: true` without employee access\n" }, "404": { "description": "No company matching `company.id` was found for this account.\n" }, "422": { "description": "Request body failed validation. Also returned when `product_detail` names a\n`special_agency_type` on a product other than Registered Agent, when\n`special_agency_type` is supplied without both `fmcsa_number` and `dot_number`, or\nwhen either number is supplied without `special_agency_type`.\n" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/accounts/{account_uuid}/orders/{order_uuid}": { "get": { "summary": "View an order", "description": "Retrieves details of a specific order by its UUID.\nUse the `include` query parameter to embed related resources.\n", "tags": [ "Orders" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/OrderUuidPathParam" }, { "$ref": "#/components/parameters/OrdersIncludeParam" } ], "responses": { "200": { "description": "Order retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Common causes:\n- Order not found or does not belong to this account\n" }, "404": { "description": "Order not found. Primarily returned when the order UUID does not exist\n(e.g. for employee callers).\n" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "patch": { "summary": "Edit an order", "description": "Updates an existing order. Only orders that have not been submitted and are for\nallowed products can be edited. You can update the company and jurisdictions.\nOmit `company` to keep the order's existing company.\n\nAuthorization rules:\n- `mark_ordered: true` \u2014 the account must have Order Now, Pay Later enabled\n- `mark_purchased: true` \u2014 the caller must be a billing admin\n- `suppress_company_onboarding: true` \u2014 employee only\n\nThe **200** response always embeds `company`, `ref_product`, `order_jurisdictions`,\nand `linked_to_order` (when applicable), regardless of the `include` query parameter.\n", "tags": [ "Orders" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/OrderUuidPathParam" } ], "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" } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Common causes:\n- Order not found or does not belong to this account\n- Order already submitted or not editable (`This order cannot be modified.`)\n- Disallowed product\n- `mark_ordered: true` when Order Now, Pay Later is not enabled\n- `mark_purchased: true` without billing admin access\n- `suppress_company_onboarding: true` without employee access\n" }, "404": { "description": "Order not found. Primarily returned when the order UUID does not exist\n(e.g. for employee callers).\n" }, "422": { "description": "Request body failed validation (e.g. missing jurisdictions, non-boolean flag values)\nor the company ID is invalid for this account.\n" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } }, "delete": { "summary": "Delete an order", "description": "Deletes an order by its UUID. Only orders that have not been submitted and are for\nallowed products can be deleted.\n", "tags": [ "Orders" ], "parameters": [ { "$ref": "#/components/parameters/AccountUuidPathParam" }, { "$ref": "#/components/parameters/OrderUuidPathParam" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "The order could not be deleted." }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden. Common causes:\n- Order not found or does not belong to this account\n- Order already submitted or not editable (`This order cannot be modified.`)\n" }, "404": { "description": "Order not found. Primarily returned when the order UUID does not exist\n(e.g. for employee callers).\n" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/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" } } } }, "/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": [] }, { "ClientCredentials": [] } ], "responses": { "200": { "description": "The OpenAPI specification document", "content": { "text/yaml": { "schema": { "type": "string", "description": "The complete OpenAPI 3.1 specification in YAML format. If authenticated, additional endpoints/schemas may be returned.\n" } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } }, "/business-name-check": { "post": { "summary": "Check a Business Name", "description": "Checks a business name and returns whether, in our best estimate, a name is valid or not. A name we estimate to be invalid returns a 200 carrying a reason, only a malformed request is a 4xx.\n", "tags": [ "Business Name Check" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessNameCheckInput" } } } }, "responses": { "200": { "description": "The name was checked. `valid` reports the outcome; a `false` result carries the reason it is likely to be denied.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "valid": { "type": "boolean", "description": "True when the name passed every check for the supplied jurisdiction.\n" }, "reason": { "type": [ "string", "null" ], "enum": [ "name_taken", "missing_identifier", "restricted_word", null ], "description": "Why the name is likely to be denied, or null when `valid` is true. `name_taken` \u2014 the name matches an existing business name in the jurisdiction. `missing_identifier` \u2014 the name carries no entity identifier (for example LLC, Corp or Inc). `restricted_word` \u2014 the name contains a word restricted in the jurisdiction.\n" }, "message": { "type": [ "string", "null" ], "description": "Human-readable explanation of `reason`, or null when `valid` is true.\n" } } } } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden \u2014 missing required `write` capability" }, "404": { "description": "`jurisdiction.id` did not resolve to an existing jurisdiction.\n" }, "422": { "description": "Request body failed validation, or a business rule was violated." }, "429": { "$ref": "#/components/responses/RateLimitExceeded" } } } } }, "components": { "parameters": { "IdempotencyKeyHeaderParam": { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Optional client-generated UUID that makes this request safe to retry. See the Idempotency section of this documentation.\n", "schema": { "type": "string", "format": "uuid" } }, "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 } }, "AccountUuidPathParam": { "name": "account_uuid", "in": "path", "required": true, "description": "Account UUID", "schema": { "type": "string", "format": "uuid" } }, "CompanyUuidPathParam": { "name": "company_uuid", "in": "path", "required": true, "description": "Company UUID", "schema": { "type": "string", "format": "uuid" } }, "UserIdPathParam": { "name": "user_uuid", "in": "path", "required": true, "description": "User UUID", "schema": { "type": "string", "format": "uuid" } }, "RecordBookUuidPathParam": { "name": "record_book_uuid", "in": "path", "required": true, "description": "Record Book UUID", "schema": { "type": "string", "format": "uuid" } }, "WifdUuidPathParam": { "name": "wifd_uuid", "in": "path", "required": true, "description": "Workflow Information Form Detail UUID", "schema": { "type": "string", "format": "uuid" } }, "LicenseUuidPathParam": { "name": "license_uuid", "in": "path", "required": true, "description": "License UUID", "schema": { "type": "string", "format": "uuid" } }, "RegistrationUuidPathParam": { "name": "registration_uuid", "in": "path", "required": true, "description": "Entity Registration UUID", "schema": { "type": "string", "format": "uuid" } }, "ProjectUuidPathParam": { "name": "project_uuid", "in": "path", "required": true, "description": "Project UUID", "schema": { "type": "string", "format": "uuid" } }, "TaskUuidPathParam": { "name": "task_uuid", "in": "path", "required": true, "description": "Task UUID", "schema": { "type": "string", "format": "uuid" } }, "CommentUuidPathParam": { "name": "comment_uuid", "in": "path", "required": true, "description": "Comment UUID", "schema": { "type": "string", "format": "uuid" } }, "CommentIsPinnedFilterParam": { "name": "filter[is_pinned]", "in": "query", "required": false, "description": "Return only pinned (`true`) or only unpinned (`false`) comments.", "schema": { "type": "boolean" } }, "RegisteredAgentDeliveryUuidPathParam": { "name": "registered_agent_delivery_uuid", "in": "path", "required": true, "description": "Registered Agent Delivery UUID", "schema": { "type": "string", "format": "uuid" } }, "MemberUuidPathParam": { "name": "member_uuid", "in": "path", "required": true, "description": "Member UUID", "schema": { "type": "string", "format": "uuid" } }, "OfficerUuidPathParam": { "name": "officer_uuid", "in": "path", "required": true, "description": "Officer UUID", "schema": { "type": "string", "format": "uuid" } }, "DirectorUuidPathParam": { "name": "director_uuid", "in": "path", "required": true, "description": "Director UUID", "schema": { "type": "string", "format": "uuid" } }, "ManagerUuidPathParam": { "name": "manager_uuid", "in": "path", "required": true, "description": "Manager UUID", "schema": { "type": "string", "format": "uuid" } }, "ShareClassUuidPathParam": { "name": "share_class_uuid", "in": "path", "required": true, "description": "Share Class UUID", "schema": { "type": "string", "format": "uuid" } }, "OrderUuidPathParam": { "name": "order_uuid", "in": "path", "required": true, "description": "Order UUID", "schema": { "type": "string", "format": "uuid" } }, "EventUuidPathParam": { "name": "event_uuid", "in": "path", "required": true, "description": "Event UUID", "schema": { "type": "string", "format": "uuid" } }, "EventsIncompleteFilterParam": { "name": "incomplete", "in": "query", "description": "When true, returns only incomplete events (ordered by due date, soonest first). When false, returns only complete events (ordered by due date, most recently completed first). Omit to return all events.\n", "required": false, "schema": { "type": "boolean" } }, "AccountNameFilterParam": { "name": "filter[name]", "in": "query", "description": "Filter accounts by exact name match.", "required": false, "schema": { "type": "string", "example": "Acme Corporation" } }, "CompanyNameFilterParam": { "name": "filter[name]", "in": "query", "description": "Filter companies by exact name match.", "required": false, "schema": { "type": "string", "example": "Acme Corporation" } }, "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" ] } } }, "ProjectsIncludeParam": { "name": "include", "in": "query", "description": "Comma-separated list of related resources to include. `status_detail` adds the status's court and status group names. It requires the `projects` capability and is ignored without it.\n", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "status_detail" ] } } }, "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": [ "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" ] } } }, "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" ] } } }, "StartBusinessRequestsIncludeParam": { "name": "include", "in": "query", "description": "Comma-separated list of related resources to include for start-a-business requests.", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "account", "company" ] } } }, "StartBusinessRequestUuidPathParam": { "name": "start_business_request_uuid", "in": "path", "required": true, "description": "Start a Business request UUID", "schema": { "type": "string", "format": "uuid" } }, "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" ] } } }, "OrdersIncludeParam": { "name": "include", "in": "query", "description": "Comma-separated list of related resources to include for orders.", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "company", "ref_product", "order_jurisdictions", "order_jurisdictions.ref_jurisdiction", "linked_to_order" ] } } }, "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." }, "RefFilingAuthorityStatusUuidPathParam": { "name": "ref_filing_authority_status_uuid", "in": "path", "required": true, "description": "UUID of the reference filing authority status.", "schema": { "type": "string", "format": "uuid" } }, "RefFilingAuthorityStatusIncludeParam": { "name": "include", "in": "query", "required": false, "description": "Comma-separated list of relations to sideload into the response. Allowed values: `ref_filing_authority`, `ref_jurisdiction`, `ref_filing_authority_status_group`.\n", "schema": { "type": "string", "maxLength": 500, "example": "ref_filing_authority,ref_filing_authority_status_group" } }, "RefFilingAuthorityStatusAuthorityFilterParam": { "name": "ref_filing_authority_id", "in": "query", "required": false, "description": "Filter by filing authority UUID.", "schema": { "type": "string", "format": "uuid" } }, "RefFilingAuthorityStatusJurisdictionFilterParam": { "name": "ref_jurisdiction_id", "in": "query", "required": false, "description": "Filter by jurisdiction UUID.", "schema": { "type": "string", "format": "uuid" } }, "RefFilingAuthorityStatusGroupFilterParam": { "name": "ref_filing_authority_status_group_id", "in": "query", "required": false, "description": "Filter by filing authority status group UUID.", "schema": { "type": "string", "format": "uuid" } } }, "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", "null" ], "description": "Website URL for the account" }, "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ], "description": "Present when requested via `include=billing_address`." }, "custom_account_id": { "type": [ "string", "null" ], "description": "Optional partner-provided external identifier for the account." }, "brand_id": { "type": "string", "format": "uuid", "readOnly": true, "description": "UUID of the brand the account belongs to. Read-only without special permission, and omitted from the response for callers who lack it." } }, "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" }, "custom_account_id": { "type": "string", "description": "Optional partner-provided external identifier for the account." } }, "required": [ "name" ] }, "Company": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the company" }, "legal_name": { "type": "string", "description": "The company's 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", "null" ], "format": "date", "description": "Company formation date (YYYY-MM-DD)" }, "fiscal_year_end": { "type": [ "string", "null" ], "description": "Fiscal year end in MM/DD format, or null" }, "phone": { "type": [ "string", "null" ], "description": "Company phone number" }, "toll_free_phone": { "type": [ "string", "null" ], "description": "Company toll-free phone number" }, "email": { "type": [ "string", "null" ], "description": "Company email address" }, "fax": { "type": [ "string", "null" ], "description": "Company fax number" }, "no_fax": { "type": "boolean", "description": "Whether the company has no fax number" }, "website": { "type": [ "string", "null" ], "description": "Company website URL" }, "no_website": { "type": "boolean", "description": "Whether the company has no website" }, "mission": { "type": [ "string", "null" ], "description": "Company mission statement" }, "purpose_statement": { "type": [ "string", "null" ], "description": "Company purpose statement" }, "primary_product_or_service": { "type": [ "string", "null" ], "description": "Primary product or service of the company" }, "ein": { "type": [ "string", "null" ], "description": "Employer Identification Number" }, "domicile": { "$ref": "#/components/schemas/Jurisdiction" }, "business_structure": { "$ref": "#/components/schemas/BusinessStructure" }, "principal_address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "mailing_address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "tax_classification": { "anyOf": [ { "$ref": "#/components/schemas/IrsTaxClassification" }, { "type": "null" } ] }, "accounting_method": { "anyOf": [ { "$ref": "#/components/schemas/AccountingMethod" }, { "type": "null" } ] }, "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", "description": "Legal name of the entity or individual holding the license." }, "license_name": { "type": "string", "description": "The formal name of the license." }, "effective_date": { "type": "string", "format": "date", "description": "Registration effective date (YYYY-MM-DD)" }, "expiration_date": { "type": [ "string", "null" ], "format": "date", "description": "Registration expiration date (YYYY-MM-DD), or null" }, "next_annual_report_due_date": { "type": [ "string", "null" ], "format": "date", "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": { "anyOf": [ { "$ref": "#/components/schemas/Jurisdiction" }, { "type": "null" } ] }, "ref_filing_authority": { "anyOf": [ { "$ref": "#/components/schemas/FilingAuthority" }, { "type": "null" } ] }, "ref_license_holder_type": { "$ref": "#/components/schemas/RefLicenseHolderType" }, "ref_license": { "anyOf": [ { "$ref": "#/components/schemas/RefLicense" }, { "type": "null" } ] }, "ref_license_types": { "type": "array", "items": { "$ref": "#/components/schemas/RefLicenseType" } }, "ref_module": { "$ref": "#/components/schemas/RefModule" }, "ref_registration_type": { "anyOf": [ { "$ref": "#/components/schemas/RefRegistrationType" }, { "type": "null" } ] }, "ref_registration_status_group": { "anyOf": [ { "$ref": "#/components/schemas/RefRegistrationStatusGroup" }, { "type": "null" } ] } }, "required": [ "id", "license_number", "effective_date" ] }, "Project": { "type": "object", "description": "A project \u2014 a unit of compliance work on an account.", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "order", "event", "project" ], "description": "Whether the project originates from an order, a compliance event, or neither." }, "project_type": { "type": [ "string", "null" ], "description": "The project type name, or null when the project has none. Additive to `type`." }, "compliance_event_name": { "type": [ "string", "null" ], "description": "Name of the project's compliance event, or null when it has none." }, "order_name": { "type": [ "string", "null" ], "description": "Name of the project's order, or null when it has none." }, "name": { "type": "string", "description": "Display name of the project." }, "status": { "type": [ "string", "null" ], "description": "Client-facing status label. Distinct from the employee-only internal status, which is returned only with the projects capability.\n" }, "ref_jurisdiction_id": { "type": [ "string", "null" ], "format": "uuid", "description": "Jurisdiction UUID." }, "jurisdictions": { "type": "array", "description": "Jurisdictions aggregated across the project's tasks (falling back to the project's own jurisdiction), each as an id/name object.\n", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid", "description": "Jurisdiction UUID." }, "name": { "type": "string", "description": "Jurisdiction name." } } } }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "year": { "type": [ "integer", "null" ] }, "task_count": { "type": "integer" }, "needs_attention": { "type": "boolean", "description": "The project has a client-court task (or is itself in a client court) that needs the client's attention." }, "is_processing": { "type": "boolean" }, "is_completed": { "type": "boolean" }, "is_cancelled": { "type": "boolean" }, "is_on_hold": { "type": "boolean" }, "created": { "type": [ "string", "null" ], "format": "date-time" }, "last_activity_date": { "type": [ "string", "null" ], "format": "date-time" }, "first_due_date": { "type": [ "string", "null" ], "format": "date" } } }, "Task": { "type": "object", "description": "A task \u2014 a unit of work within a project.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Display name of the task." }, "status": { "type": [ "string", "null" ], "description": "Client-facing status label (for example \"Information Needed\"). Distinct from the employee-only internal status, which is returned only with the projects capability.\n" }, "ref_jurisdiction_id": { "type": [ "string", "null" ], "format": "uuid", "description": "Jurisdiction UUID." }, "task_type": { "type": [ "string", "null" ], "description": "The task type name, or null when the task has no task type." }, "event_type_name": { "type": [ "string", "null" ], "description": "Name of the task's event type, or null when it has none." }, "order_name": { "type": [ "string", "null" ], "description": "Name of the task's order, or null when it has none." }, "due_date": { "type": [ "string", "null" ], "format": "date", "description": "Effective due date from the task's compliance event, or null when the task has no compliance event (for example order-derived tasks).\n" }, "created": { "type": [ "string", "null" ], "format": "date-time", "nullable": true } } }, "Comment": { "type": "object", "description": "A comment on a project or task. With the `projects` capability the response also includes the employee-only fields.\n", "properties": { "id": { "type": "string", "format": "uuid" }, "body": { "type": "string", "description": "The comment body, as sanitized HTML." }, "is_pinned": { "type": "boolean" }, "is_new": { "type": "boolean", "description": "Whether the calling user has not yet read the comment in the portal. Reading through the API does not change this. Not returned to a partner client, which has no user.\n" }, "created": { "type": "string", "format": "date-time", "nullable": true }, "author": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true, "description": "Author user UUID." }, "name": { "type": "string", "nullable": true }, "is_harbor_employee": { "type": "boolean" } } } } }, "EntityRegistration": { "description": "An Entity Manager registration of a company with a corporate registrar.", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "id of the registration." }, "registration_number": { "type": [ "string", "null" ], "description": "The registration/file number issued by the filing authority, or null." }, "entity_type": { "type": [ "string", "null" ], "description": "The legal entity type of the registration - the per-registration override when one is set, otherwise the company's business structure.\n" }, "registered_name": { "type": [ "string", "null" ], "description": "The name the entity is registered under in this jurisdiction." }, "effective_date": { "type": [ "string", "null" ], "format": "date", "description": "Registration effective date (YYYY-MM-DD), or null." }, "termination_date": { "type": [ "string", "null" ], "format": "date", "description": "The registration's effective expiration date (YYYY-MM-DD), or null. Derived from the registration's expiration date (or its renewal-event-calculated expiration date when that is in use).\n" }, "is_registered": { "type": "boolean", "description": "True when the registration has an effective date or a registration number." }, "agency_last_import_date": { "type": [ "string", "null" ], "format": "date", "description": "When the filing authority record was last harvested (YYYY-MM-DD), or null." }, "next_annual_report_due_date": { "type": [ "string", "null" ], "format": "date", "description": "Due date of the next incomplete annual report for this registration (YYYY-MM-DD), or null when there is none.\n" }, "overdue": { "type": "boolean", "description": "True when the next incomplete annual report is past due." }, "ref_jurisdiction": { "anyOf": [ { "$ref": "#/components/schemas/Jurisdiction" }, { "type": "null" } ] }, "ref_filing_authority": { "anyOf": [ { "$ref": "#/components/schemas/FilingAuthority" }, { "type": "null" } ] }, "ref_registration_status_group": { "anyOf": [ { "$ref": "#/components/schemas/RefRegistrationStatusGroup" }, { "type": "null" } ] } }, "required": [ "id" ] }, "CompanyRegistrationInput": { "type": "object", "description": "Payload for creating a license under License Manager. The license holder (company or individual) is determined by the URL path.\n**Custom license:** omit `ref_license` and supply at least one entry in `ref_license_types`.\n**Import from catalog:** supply `ref_license` to copy defaults from the catalog record. Any explicitly provided field overrides the corresponding catalog value (including `ref_license_types`, `ref_jurisdiction`, and `ref_filing_authority`).\n", "properties": { "license_number": { "type": "string", "maxLength": 255, "description": "Registration or license number issued by the filing authority" }, "license_name": { "type": "string", "maxLength": 255, "description": "The formal name of the license" }, "license_holder_on_license": { "type": "string", "maxLength": 255, "description": "Legal name of the entity as stated on the license" }, "effective_date": { "type": "string", "format": "date", "description": "Registration effective date (YYYY-MM-DD)" }, "expiration_date": { "type": "string", "format": "date", "description": "Registration expiration date (YYYY-MM-DD)" }, "ref_jurisdiction": { "$ref": "#/components/schemas/JurisdictionInput" }, "ref_filing_authority": { "$ref": "#/components/schemas/FilingAuthorityInput" }, "ref_license": { "$ref": "#/components/schemas/RefLicenseInput" }, "ref_license_types": { "type": "array", "description": "License type classifications. Required when `ref_license` is not provided. When both `ref_license` and `ref_license_types` are provided, the explicit types win over the catalog types. Use the /ref-license-types endpoint to look up valid IDs.\n", "items": { "$ref": "#/components/schemas/RefLicenseTypeInput" } } } }, "CompanyRegistrationUpdate": { "type": "object", "description": "Payload for updating a company license under License Manager. All fields are optional; only provided fields will be updated. The `ref_license` catalog reference cannot be changed after creation.\n", "properties": { "license_number": { "type": "string", "maxLength": 255, "description": "Registration or license number issued by the filing authority" }, "license_name": { "type": "string", "maxLength": 255, "description": "The formal name of the license" }, "license_holder_on_license": { "type": "string", "maxLength": 255, "description": "Legal name of the entity as stated on the license" }, "effective_date": { "type": "string", "format": "date", "description": "Registration effective date (YYYY-MM-DD)" }, "expiration_date": { "type": "string", "format": "date", "description": "Registration expiration date (YYYY-MM-DD)" }, "ref_jurisdiction": { "$ref": "#/components/schemas/JurisdictionInput" }, "ref_filing_authority": { "$ref": "#/components/schemas/FilingAuthorityInput" }, "ref_license_types": { "type": "array", "description": "License type classifications. When provided, must contain at least one entry. Use the /ref-license-types endpoint to look up valid IDs.\n", "items": { "$ref": "#/components/schemas/RefLicenseTypeInput" } } } }, "Event": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the event" }, "name": { "type": "string", "description": "The name of the event" }, "ref_event_type": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "due_date": { "type": [ "string", "null" ], "format": "date", "description": "The event's effective due date (YYYY-MM-DD)" }, "due_date_override": { "type": [ "string", "null" ], "format": "date", "description": "An extended/overridden due date (YYYY-MM-DD)" }, "frequency": { "type": "string", "enum": [ "one_time", "annual", "biennial", "custom" ], "description": "How often the event recurs" }, "renewal_interval": { "type": [ "integer", "null" ], "description": "The numeric recurrence interval, present when frequency is `custom`" }, "renewal_interval_unit": { "type": [ "string", "null" ], "enum": [ "day", "month", "quarter", "week", null ], "description": "The unit for renewal_interval, present when frequency is `custom`" }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } }, "state_fee": { "type": [ "number", "null" ], "format": "float" }, "state_fee_override": { "type": [ "number", "null" ], "format": "float" }, "managed": { "type": "boolean", "description": "Whether this event is managed (created/maintained internally)" }, "event_is_overdue": { "type": "boolean" } } }, "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", "null" ], "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" ] }, "PreconfiguredProduct": { "type": "object", "description": "A pre-configured product bundle set up for an account.", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the preconfigured product" }, "product": { "$ref": "#/components/schemas/Product" }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/Jurisdiction" } } }, "required": [ "id" ] }, "Address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "First line of the address" }, "address_line_2": { "type": [ "string", "null" ], "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 /ref-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" ] }, "FilingAuthorityInput": { "type": "object", "description": "A filing authority reference for use in request bodies. Only the id is required; use the /ref-filing-authorities endpoint to look up valid IDs.\n", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID of the filing authority" } }, "required": [ "id" ] }, "RefLicenseInput": { "type": "object", "description": "Request body for creating a reference license.", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID of the reference license" }, "name": { "type": "string", "maxLength": 255 }, "ref_jurisdiction": { "$ref": "#/components/schemas/RefLicenseRelationInput" }, "ref_license_holder_type": { "$ref": "#/components/schemas/RefLicenseRelationInput" }, "ref_filing_authority": { "$ref": "#/components/schemas/RefLicenseRelationInput" }, "introduction": { "type": [ "string", "null" ] }, "not_required": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ] }, "legal_notes": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] }, "fact_checked": { "type": [ "string", "null" ], "format": "date" }, "classifications": { "type": [ "string", "null" ] }, "bond_amount": { "type": [ "string", "null" ] }, "requirement_notes": { "type": [ "string", "null" ] }, "foreign_qualification_required": { "type": [ "boolean", "null" ] }, "registered_agent_special_agency_required": { "type": [ "boolean", "null" ] }, "disclosure_details": { "type": [ "string", "null" ] }, "disclosure_required": { "type": [ "string", "null" ] }, "is_qualifying_individual_license_required": { "type": [ "boolean", "null" ] }, "qualifying_individual_requirements": { "type": [ "string", "null" ] }, "ownership_requirements": { "type": [ "string", "null" ] }, "entity_requirements": { "type": [ "string", "null" ] }, "is_exam_required": { "type": [ "boolean", "null" ] }, "employee_only_notes": { "type": [ "string", "null" ] }, "make_check_payable_to": { "type": [ "string", "null" ], "maxLength": 255 }, "legal_notes_vp_id": { "type": [ "integer", "null" ] }, "foreign_qualification_required_vp_id": { "type": [ "integer", "null" ] }, "registered_agent_special_agency_required_vp_id": { "type": [ "integer", "null" ] }, "not_required_vp_id": { "type": [ "integer", "null" ] } }, "required": [ "id", "name", "ref_jurisdiction", "ref_license_holder_type" ] }, "RefLicenseTypeInput": { "type": "object", "description": "Request body for creating a global reference license type.", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the license type" }, "name": { "type": "string", "maxLength": 255 }, "ref_module": { "$ref": "#/components/schemas/RefLicenseTypeRelationInput" }, "ref_license_holder_type": { "$ref": "#/components/schemas/RefLicenseTypeRelationInput" }, "ref_industry": { "$ref": "#/components/schemas/RefLicenseTypeRelationInput" }, "description": { "type": [ "string", "null" ] }, "active": { "type": [ "boolean", "null" ], "description": "Defaults to `true` when omitted." } }, "required": [ "id", "name", "ref_module", "ref_license_holder_type" ] }, "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": { "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" } } }, "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", "null" ], "format": "date", "description": "Date of membership transfer (YYYY-MM-DD)" }, "percent_ownership": { "type": [ "number", "null" ], "format": "float", "description": "Ownership percentage (0.00001 to 1.0)" }, "amount_paid": { "type": [ "number", "null" ], "format": "float", "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", "null" ], "format": "date", "description": "Officer start date (YYYY-MM-DD)" }, "end_date": { "type": [ "string", "null" ], "format": "date", "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" ] }, "ArIfStateAnswer": { "type": [ "object", "null" ], "description": "A company's state-specific AR-IF answers for one Workflow Information Form Detail. Only the fields allow-listed for that detail's jurisdiction are present \u2014 a Wyoming row never carries Delaware fields and vice versa. `null` when no answers have been submitted for this detail yet.\n", "properties": { "workflow_information_form_detail_id": { "type": "string", "format": "uuid", "description": "UUID of the parent Workflow Information Form Detail" }, "ref_jurisdiction_id": { "type": "string", "format": "uuid", "description": "UUID of the jurisdiction this row's fields are scoped to" }, "wyoming_business_has_assets_or_employees": { "type": [ "boolean", "null" ], "description": "Wyoming only. Whether the business has assets or employees located in Wyoming. Always client-answered \u2014 never derived or sent by an automated caller. `null` means unanswered. A `false` value alongside populated Wyoming line items in the same write is rejected (see the write schema).\n" }, "wyoming_asset_amount_cash": { "type": [ "string", "null" ] }, "wyoming_trade_notes_and_acct_receivables": { "type": [ "string", "null" ] }, "wyoming_subtract_allowance_for_bad_debts": { "type": [ "string", "null" ] }, "wyoming_inventories_cash_value": { "type": [ "string", "null" ] }, "wyoming_united_states_government_obligations": { "type": [ "string", "null" ] }, "wyoming_tax_exempt_securities": { "type": [ "string", "null" ] }, "wyoming_other_current_assets": { "type": [ "string", "null" ] }, "wyoming_loans_to_stockholders": { "type": [ "string", "null" ] }, "wyoming_mortgage_real_estate_loans": { "type": [ "string", "null" ] }, "wyoming_other_investments": { "type": [ "string", "null" ] }, "wyoming_buildings_and_tangible_assets": { "type": [ "string", "null" ] }, "wyoming_depletable_assets": { "type": [ "string", "null" ] }, "wyoming_land_assessed_value": { "type": [ "string", "null" ] }, "wyoming_intangible_assets": { "type": [ "string", "null" ] }, "wyoming_accumulated_amortization": { "type": [ "string", "null" ] }, "wyoming_other_assets": { "type": [ "string", "null" ] }, "delaware_gross_assets": { "type": [ "string", "null" ], "description": "Delaware only. `null` is expected and valid when issued shares are \u2264 5,000 (Delaware's minimum-stock path provides no source value).\n" }, "delaware_nature_of_business": { "type": [ "string", "null" ], "description": "Delaware only." }, "delaware_other_nature_of_business": { "type": [ "string", "null" ], "maxLength": 60, "description": "Delaware only. Required, non-empty, and at most 60 characters when delaware_nature_of_business is 'Other' \u2014 enforced by the table on save and surfaced as a field-keyed 422, not silently accepted.\n" } } }, "ArIfStateAnswerInput": { "type": "object", "description": "Only the fields allow-listed for the target Workflow Information Form Detail's jurisdiction may be sent; any other key is rejected with a field-keyed 422. Sparse payloads (most keys absent) are valid \u2014 omitting a key never fails, but sending wyoming_business_has_assets_or_employees as `false` alongside any populated Wyoming line item in the same request is rejected, since that combination would otherwise silently null out the line items on save.\n", "additionalProperties": false, "properties": { "wyoming_business_has_assets_or_employees": { "type": [ "boolean", "null" ] }, "wyoming_asset_amount_cash": { "type": [ "string", "null" ] }, "wyoming_trade_notes_and_acct_receivables": { "type": [ "string", "null" ] }, "wyoming_subtract_allowance_for_bad_debts": { "type": [ "string", "null" ] }, "wyoming_inventories_cash_value": { "type": [ "string", "null" ] }, "wyoming_united_states_government_obligations": { "type": [ "string", "null" ] }, "wyoming_tax_exempt_securities": { "type": [ "string", "null" ] }, "wyoming_other_current_assets": { "type": [ "string", "null" ] }, "wyoming_loans_to_stockholders": { "type": [ "string", "null" ] }, "wyoming_mortgage_real_estate_loans": { "type": [ "string", "null" ] }, "wyoming_other_investments": { "type": [ "string", "null" ] }, "wyoming_buildings_and_tangible_assets": { "type": [ "string", "null" ] }, "wyoming_depletable_assets": { "type": [ "string", "null" ] }, "wyoming_land_assessed_value": { "type": [ "string", "null" ] }, "wyoming_intangible_assets": { "type": [ "string", "null" ] }, "wyoming_accumulated_amortization": { "type": [ "string", "null" ] }, "wyoming_other_assets": { "type": [ "string", "null" ] }, "delaware_gross_assets": { "type": [ "string", "null" ] }, "delaware_nature_of_business": { "type": [ "string", "null" ] }, "delaware_other_nature_of_business": { "type": [ "string", "null" ], "maxLength": 60 } } }, "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", "null" ], "format": "date", "description": "Director start date (YYYY-MM-DD)" }, "end_date": { "type": [ "string", "null" ], "format": "date", "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", "null" ], "format": "date", "description": "Manager start date (YYYY-MM-DD)" }, "end_date": { "type": [ "string", "null" ], "format": "date", "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" ] }, "RecordBookShareClass": { "type": "object", "description": "A class of shares belonging to a record book.", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the share class record" }, "class_name": { "type": "string", "description": "The share class (e.g. Common, Preferred)" }, "series": { "type": [ "string", "null" ], "description": "The series within the class. Null when no_series is true." }, "no_series": { "type": "boolean", "description": "True when the class has no series." }, "shares_authorized": { "type": [ "integer", "null" ], "description": "Number of shares authorized. Null only when has_unlimited_authorized_shares is true; otherwise must be greater than 0.\n" }, "has_unlimited_authorized_shares": { "type": "boolean", "description": "True when the class authorizes an unlimited number of shares." }, "shares_issued": { "type": [ "integer", "null" ], "description": "Number of shares issued. May not exceed shares_authorized unless has_unlimited_authorized_shares is true. Required for the annual report's Shares step to pass, even though a share class can be saved without it.\n" }, "par_value": { "type": [ "string", "null" ], "description": "Par value per share, to six decimal places. Null when no_par_value is true.\n" }, "no_par_value": { "type": [ "boolean", "null" ], "description": "True when the class has no par value." } }, "required": [ "id" ] }, "RecordBookShareClassInput": { "type": "object", "description": "No field is defaulted server-side, so `no_series`, `has_unlimited_authorized_shares` and `no_par_value` are all required \u2014 an unset flag does not read as false, and an unset flag whose partner field is also absent would otherwise save an incomplete share class.\n", "properties": { "class_name": { "type": "string", "maxLength": 50, "description": "The share class (e.g. Common)" }, "series": { "type": [ "string", "null" ], "maxLength": 50, "description": "Required unless no_series is true, and rejected when it is." }, "no_series": { "type": "boolean", "description": "True when the class has no series." }, "shares_authorized": { "type": [ "integer", "null" ], "description": "Required unless has_unlimited_authorized_shares is true. Must be greater than 0.\n" }, "has_unlimited_authorized_shares": { "type": "boolean", "description": "True when the class authorizes an unlimited number of shares." }, "shares_issued": { "type": [ "integer", "null" ], "description": "May not exceed shares_authorized unless has_unlimited_authorized_shares is true. Omitting it saves successfully but leaves the annual report's Shares step unable to pass.\n" }, "par_value": { "type": [ "string", "null" ], "description": "Required unless no_par_value is true, and rejected when it is." }, "no_par_value": { "type": [ "boolean", "null" ], "description": "True when the class has no par value. Required, and null is accepted only because the paired rule that rejects a null alongside a null par_value lives on the record itself \u2014 send a boolean. A null saves as null when par_value is provided, which no caller wants.\n" } }, "required": [ "class_name", "no_series", "has_unlimited_authorized_shares", "no_par_value" ] }, "RecordBookShareClassUpdateInput": { "type": "object", "description": "Partial update. Every field is optional, but the class's validation rules are re-checked against the merged record, so a change that unpairs a flag from its partner field is rejected.\n", "properties": { "class_name": { "type": "string", "maxLength": 50 }, "series": { "type": [ "string", "null" ], "maxLength": 50 }, "no_series": { "type": "boolean" }, "shares_authorized": { "type": [ "integer", "null" ] }, "has_unlimited_authorized_shares": { "type": "boolean" }, "shares_issued": { "type": [ "integer", "null" ] }, "par_value": { "type": [ "string", "null" ] }, "no_par_value": { "type": [ "boolean", "null" ], "description": "Null is accepted and persists as null, so send a boolean. See RecordBookShareClassInput.\n" } } }, "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" ] }, "RefFilingAuthority": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "id of the Ref Filing Authority" }, "name": { "type": "string", "description": "Name of the Ref Filing Authority" } }, "required": [ "id", "name" ] }, "RefFilingAuthorityStatusGroup": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "id of the Ref Filing Authority Status Group" }, "name": { "type": "string", "description": "Name of the Ref Filing Authority Status Group" } }, "required": [ "id", "name" ] }, "RefFilingAuthorityStatus": { "type": "object", "description": "An operational status window for a filing authority, or for a whole jurisdiction when no filing authority is set.\n", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the filing authority status" }, "ref_filing_authority_id": { "type": [ "string", "null" ], "format": "uuid", "description": "UUID of the related filing authority" }, "ref_jurisdiction_id": { "type": [ "string", "null" ], "format": "uuid", "description": "UUID of the related jurisdiction" }, "ref_filing_authority_status_group_id": { "type": [ "string", "null" ], "format": "uuid", "description": "UUID of the related status group" }, "status_description": { "type": [ "string", "null" ] }, "status_start_date": { "type": [ "string", "null" ], "format": "date-time", "description": "When the status takes effect" }, "status_end_date": { "type": [ "string", "null" ], "format": "date-time", "description": "When the status stops applying; null means open-ended" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": [ "string", "null" ], "format": "date-time" }, "ref_filing_authority": { "$ref": "#/components/schemas/RefFilingAuthority" }, "ref_jurisdiction": { "$ref": "#/components/schemas/RefJurisdiction" }, "ref_filing_authority_status_group": { "$ref": "#/components/schemas/RefFilingAuthorityStatusGroup" } } }, "RefJurisdiction": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Jurisdiction" }, "name": { "type": "string", "description": "Name of the Jurisdiction" } }, "required": [ "id", "name" ] }, "RefLicense": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the License" }, "name": { "type": "string", "description": "Name of the License" } }, "required": [ "id", "name" ] }, "RefEventType": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Ref Event Type" }, "name": { "type": "string", "description": "Name of the Ref Event Type" }, "description": { "type": [ "string", "null" ], "description": "Description of the Ref Event Type" } }, "required": [ "id" ] }, "RefProjectType": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Ref Project Type" }, "name": { "type": "string", "description": "Name of the Ref Project Type" }, "description": { "type": "string", "nullable": true, "description": "Description of the Ref Project Type" } }, "required": [ "id", "name" ] }, "RefWorkflowStatusGroup": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Ref Workflow Status Group" }, "name": { "type": "string", "description": "Name of the Ref Workflow Status Group" }, "sort_order": { "type": "integer", "description": "Display order of the Ref Workflow Status Group" } }, "required": [ "id", "name" ] }, "RefWorkflowStatus": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Ref Workflow Status" }, "name": { "type": "string", "description": "Internal name of the Ref Workflow Status" }, "name_visible_to_client": { "type": "string", "description": "Client-facing name of the Ref Workflow Status" }, "sort_order": { "type": "integer", "description": "Display order of the Ref Workflow Status" } }, "required": [ "id", "name" ] }, "RefTaskType": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Ref Task Type" }, "name": { "type": "string", "description": "Name of the Ref Task Type" }, "sort_order": { "type": "integer", "nullable": true, "description": "Display order of the Ref Task Type" } }, "required": [ "id", "name", "name" ] }, "RmRefOfficerTitle": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Officer Title" }, "name": { "type": "string", "description": "Name of the Officer Title" } }, "required": [ "id", "name" ] }, "RmRefDirectorPosition": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the Director Position" }, "name": { "type": "string", "description": "Name of the Director Position" } }, "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" ] }, "RefLicenseTypeDetail": { "type": "object", "description": "Global reference license type. Without the `ref-data-admin` capability only `id` and `name` are returned.\n", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the license type" }, "name": { "type": "string", "description": "Name of the license type" } }, "required": [ "id", "name" ] }, "RefLicenseLicenseTypeDetail": { "type": "object", "description": "Link between a Ref License and a Ref License Type.", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the license/license-type link" }, "ref_license_type_id": { "type": "string", "format": "uuid", "description": "UUID of the linked Ref License Type" }, "ref_license_id": { "type": "string", "format": "uuid", "description": "UUID of the linked Ref License" } }, "required": [ "id", "ref_license_type_id", "ref_license_id" ] }, "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" ] }, "CompanyInput": { "type": "object", "properties": { "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": [ "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", "null" ], "format": "date-time", "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." }, "StartBusinessRequest": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier for this start-a-business request" }, "account_id": { "type": "string", "format": "uuid", "description": "UUID of the account created by this request" }, "company_id": { "type": "string", "format": "uuid", "description": "UUID of the company created by this request" }, "elect_s_corp_status": { "type": "boolean", "description": "Whether the requester wants to elect S-Corp tax status" }, "expects_to_hire_next_12_months": { "type": "boolean", "description": "Whether the business expects to hire W-2 employees within the next 12 months" }, "expected_employee_count": { "type": [ "integer", "null" ], "description": "Expected number of employees, when expects_to_hire_next_12_months is true" }, "expected_first_wages_date": { "type": [ "string", "null" ], "format": "date", "description": "First date wages are expected to be paid (YYYY-MM-DD)" }, "created": { "type": "string", "format": "date-time" }, "account": { "$ref": "#/components/schemas/Account" }, "company": { "$ref": "#/components/schemas/Company" } } }, "StartBusinessStatus": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "description": "The current status of the business formation. \"Processing\" while it is being set up right after the request, then reflects the formation's progress.\n" } } }, "Order": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier for the order" }, "name": { "type": "string", "description": "The order's display name (e.g. the product name)" }, "linked_to_order_id": { "type": [ "string", "null" ], "format": "uuid", "description": "UUID of a related order, if applicable" }, "linked_to_order": { "anyOf": [ { "$ref": "#/components/schemas/Order" }, { "type": "null" } ], "description": "Nested related order. Present when requested via `include=linked_to_order` on GET, or always embedded on POST/PATCH responses when applicable.\n" }, "company": { "anyOf": [ { "$ref": "#/components/schemas/Company" }, { "type": "null" } ], "description": "Present when requested via `include=company` on GET, or always embedded on POST/PATCH responses.\n" }, "ref_product": { "allOf": [ { "$ref": "#/components/schemas/Product" } ], "description": "Present when requested via `include=ref_product` on GET, or always embedded on POST/PATCH responses.\n" }, "order_jurisdictions": { "type": "array", "description": "Present when requested via `include=order_jurisdictions` on GET, or always embedded on POST/PATCH responses.\n", "items": { "type": "object", "required": [ "ref_jurisdiction_id" ], "properties": { "ref_jurisdiction_id": { "type": "string", "format": "uuid", "description": "Jurisdiction UUID" }, "ref_jurisdiction": { "anyOf": [ { "$ref": "#/components/schemas/Jurisdiction" }, { "type": "null" } ] } } } }, "product_detail": { "type": "object", "description": "Present only on Registered Agent orders placed with `special_agency_type` (BOC-3). Echoes back the submitted special agency details. Omitted for all other orders.\n", "properties": { "special_agency_type": { "type": "string", "enum": [ "BOC-3" ] }, "fmcsa_number": { "type": [ "string", "null" ] }, "dot_number": { "type": [ "string", "null" ] } } } } }, "OrderInput": { "type": "object", "required": [ "jurisdictions" ], "properties": { "company": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "The UUID of the company. Optional; omit to keep the order's existing 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. The account must have\nOrder Now, Pay Later enabled. Must be a JSON boolean (`true`/`false`). String\nand numeric values (e.g. `\"false\"`, `1`) are rejected with 422.\n" }, "mark_purchased": { "type": "boolean", "default": false, "description": "Requires billing admin. When true, marks the order as purchased without payment.\nMust be a JSON boolean (`true`/`false`). String and numeric values (e.g. `\"false\"`,\n`1`) are rejected with 422.\n" }, "suppress_company_onboarding": { "type": "boolean", "default": false, "description": "Employee-only. When true, suppresses company onboarding for the order.\nMust be a JSON boolean (`true`/`false`). String and numeric values (e.g. `\"false\"`,\n`1`) are rejected with 422.\n" } } }, "OrderProductDetailInput": { "type": "object", "description": "Optional product-specific detail supplied at order creation. Designates the order as\na BOC-3 special agency appointment and carries the motor carrier's federal\nidentifiers. Omit the whole object for an ordinary Secretary of State Registered\nAgent order.\n\n`special_agency_type` is what activates the object. Without it the object carries no\ndesignation and is ignored, and the order is created exactly as if it had not been\nsent \u2014 this includes an empty object and one holding only unrecognised keys, for any\nproduct.\n\nWhen `special_agency_type` **is** present:\n- the product must be Registered Agent, otherwise the request returns 422;\n- both `fmcsa_number` and `dot_number` become required.\n\nSupplying either number without `special_agency_type` returns 422, so the numbers can\nonly ever attach to a BOC-3 order.\n\nThe numbers are stored as structured order data and shown to fulfillment staff. They\nare echoed back in the order's `product_detail` response field.\n", "properties": { "special_agency_type": { "type": "string", "enum": [ "BOC-3" ], "description": "The special agency designation, and the field that activates this object.\n`BOC-3` is the only value accepted today. Supplying it records the order as\nSpecial Agency = Yes with type BOC-3, requires both numbers, and restricts the\nrequest to Registered Agent. Omitting it makes the whole object a no-op.\n" }, "fmcsa_number": { "type": "string", "maxLength": 50, "description": "The carrier's FMCSA number. Required when `special_agency_type` is provided.\nStored as supplied \u2014 no format validation is applied.\n" }, "dot_number": { "type": "string", "maxLength": 50, "description": "The carrier's DOT number. Required when `special_agency_type` is provided.\nStored as supplied \u2014 no format validation is applied.\n" } } }, "OrderCreateWithProduct": { "type": "object", "required": [ "company", "product" ], "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, Registered\nAgent, LLC Formation Package, or Corporation Formation Package.\n" } } }, "jurisdictions": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/JurisdictionInput" }, "description": "Required (non-empty) for Annual Report, Change of Registered Agent, and Registered\nAgent \u2014 omitting it returns 422. Not used for LLC Formation Package or Corporation\nFormation Package: those derive their single filing jurisdiction automatically from\nthe company's own domicile, and any value sent here is ignored.\n" }, "product_detail": { "$ref": "#/components/schemas/OrderProductDetailInput" }, "linked_to_order_id": { "type": [ "string", "null" ], "format": "uuid", "description": "Optional UUID of a related order" }, "suppress_company_onboarding": { "type": "boolean", "default": false, "description": "Employee-only. When true, suppresses company onboarding for the created order.\nMust be a JSON boolean (`true`/`false`). String and numeric values (e.g. `\"false\"`,\n`1`) are rejected with 422.\n" }, "mark_ordered": { "type": "boolean", "default": false, "description": "Marks the order as ordered without waiting for payment. The account must have\nOrder Now, Pay Later enabled. Must be a JSON boolean (`true`/`false`). String\nand numeric values (e.g. `\"false\"`, `1`) are rejected with 422.\n" }, "mark_purchased": { "type": "boolean", "default": false, "description": "Requires billing admin. When true, marks the order as purchased without payment.\nMust be a JSON boolean (`true`/`false`). String and numeric values (e.g. `\"false\"`,\n`1`) are rejected with 422.\n" } } }, "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)" } } }, "product_detail": { "$ref": "#/components/schemas/OrderProductDetailInput" }, "suppress_company_onboarding": { "type": "boolean", "default": false, "description": "Employee-only. When true, suppresses company onboarding for the created order.\nMust be a JSON boolean (`true`/`false`). String and numeric values (e.g. `\"false\"`,\n`1`) are rejected with 422.\n" }, "mark_ordered": { "type": "boolean", "default": false, "description": "Marks the order as ordered without waiting for payment. The account must have\nOrder Now, Pay Later enabled. Must be a JSON boolean (`true`/`false`). String\nand numeric values (e.g. `\"false\"`, `1`) are rejected with 422.\n" }, "mark_purchased": { "type": "boolean", "default": false, "description": "Requires billing admin. When true, marks the order as purchased without payment.\nMust be a JSON boolean (`true`/`false`). String and numeric values (e.g. `\"false\"`,\n`1`) are rejected with 422.\n" } } }, "BusinessNameCheckInput": { "type": "object", "required": [ "name", "jurisdiction" ], "properties": { "name": { "type": "string", "maxLength": 255, "description": "The proposed business name, as it would be filed." }, "jurisdiction": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the jurisdiction the name would be filed in. Resolve one from `GET /jurisdictions`.\n" } } } } }, "StartBusinessErrorMessage": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string", "example": "API client cannot start a business under another partner." }, "url": { "type": "string", "example": "/api/v3/start-a-business" }, "code": { "type": "integer", "example": 403 } } }, "StartBusinessValidationError": { "type": "object", "required": [ "message", "errors" ], "properties": { "message": { "type": "string", "example": "The given data was invalid." }, "errors": { "type": "object", "description": "Keyed by the request path of the failing field (nested), or by a business rule name. Each failure is an object with a `message` key (schema validation), a list of messages, or messages keyed by rule.\n", "additionalProperties": true } } }, "StartBusinessInput": { "type": "object", "additionalProperties": false, "required": [ "company", "user" ], "properties": { "company": { "description": "The company to form.", "type": "object", "additionalProperties": false, "required": [ "legal_name", "business_structure", "domicile", "business_purpose", "elect_s_corp_status", "expects_to_hire_next_12_months", "principal_address" ], "if": { "required": [ "expects_to_hire_next_12_months" ], "properties": { "expects_to_hire_next_12_months": { "const": true } } }, "then": { "required": [ "expected_employee_count", "expected_first_wages_date" ], "properties": { "expected_employee_count": { "type": "integer" }, "expected_first_wages_date": { "type": "string" } } }, "properties": { "business_purpose": { "description": "Short statement of what the business does, up to 250 characters.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Roasting and selling specialty coffee." }, "business_structure": { "description": "Entity type to form, such as an LLC or a corp. Decides which personnel and shares rules apply.", "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "description": "UUID of the business structure.", "type": "string", "format": "uuid", "minLength": 36, "maxLength": 36 } } }, "domicile": { "description": "The state the company is formed in.", "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "description": "UUID of the domicile jurisdiction.", "type": "string", "format": "uuid", "minLength": 36, "maxLength": 36 } } }, "elect_s_corp_status": { "description": "Not allowed for a non-profit business structure.", "type": "boolean", "example": false }, "expects_to_hire_next_12_months": { "description": "Whether the company expects to hire in the next 12 months. When true, the expected headcount and first wages date are required.", "type": "boolean", "example": true }, "legal_name": { "description": "Legal name of the company, as it will be registered.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 255, "example": "Blue Harbor Coffee LLC" }, "principal_address": { "description": "The company's principal address. Always required.", "$ref": "#/components/schemas/StartBusinessPrincipalAddressInput" }, "expected_employee_count": { "description": "Required when expects_to_hire_next_12_months is true.", "x-conditionally-required": true, "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647, "example": 5 }, "expected_first_wages_date": { "description": "Required when expects_to_hire_next_12_months is true.", "x-conditionally-required": true, "type": [ "string", "null" ], "format": "date", "minLength": 10, "maxLength": 10, "example": "2026-03-01" }, "managers": { "description": "Required for an LLC without members. Not allowed for a corp.", "x-conditionally-required": true, "type": [ "array", "null" ], "minItems": 1, "items": { "$ref": "#/components/schemas/StartBusinessManagerInput" } }, "members": { "description": "Required for an LLC without managers. Not allowed for a corp.", "x-conditionally-required": true, "type": [ "array", "null" ], "minItems": 1, "items": { "$ref": "#/components/schemas/StartBusinessMemberInput" } }, "shares": { "description": "Required for a for-profit corp, depending on the state selected. Not allowed for an LLC.", "x-conditionally-required": true, "$ref": "#/components/schemas/StartBusinessSharesInput" }, "directors": { "description": "Optional for a for-profit corp. Not allowed for an LLC.", "type": [ "array", "null" ], "minItems": 1, "items": { "$ref": "#/components/schemas/StartBusinessDirectorInput" } }, "doing_business_as": { "description": "One DBA name (string) or multiple (array of strings).", "oneOf": [ { "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 100 }, { "type": "array", "minItems": 1, "items": { "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 100 } }, { "type": "null" } ], "example": "Blue Harbor Coffee" }, "domicile_city": { "description": "City the company is domiciled in.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 255, "example": "Washington" }, "fiscal_year_end": { "description": "Preferred last day of the fiscal year, as MM/DD. Not guaranteed, we'll do our best to honor it.", "type": [ "string", "null" ], "minLength": 5, "maxLength": 5, "format": "month-day-field", "x-format-message": "Must be a month and day as MM/DD, e.g. 12/31.", "example": "12/31" }, "formation_date": { "description": "Preferred formation date, as YYYY-MM-DD. Not guaranteed, we'll do our best to honor it.", "type": [ "string", "null" ], "format": "date", "minLength": 10, "maxLength": 10, "example": "2026-01-15" }, "mailing_address": { "description": "The company's mailing address.", "$ref": "#/components/schemas/StartBusinessAddressInput" }, "officers": { "description": "Optional for a for-profit corp. Not allowed for an LLC.", "type": [ "array", "null" ], "minItems": 1, "items": { "$ref": "#/components/schemas/StartBusinessOfficerInput" } }, "primary_product_or_service": { "description": "Description of the primary product or service the company offers.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 16383, "example": "Specialty coffee beans" }, "registered_agent": { "$ref": "#/components/schemas/StartBusinessRegisteredAgentInput", "description": "Omit registered_agent to appoint the default registered agent provider. Provide a valid registered_agent object to use a custom agent. Including an empty object will return a schema validation error.\n" } } }, "user": { "description": "The person starting the business and the responsible party. A user is created from these details.", "type": "object", "additionalProperties": false, "required": [ "first_name", "last_name", "email", "is_eu_citizen", "phone" ], "dependentRequired": { "tax_id": [ "tax_id_type" ], "tax_id_type": [ "tax_id" ] }, "properties": { "email": { "description": "User's email address.", "type": "string", "format": "email", "minLength": 3, "maxLength": 255, "example": "jane.doe@example.com" }, "first_name": { "description": "User's first name.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Jane" }, "is_eu_citizen": { "description": "Whether the user is a citizen of an EU country.", "type": "boolean", "example": false }, "last_name": { "description": "User's last name.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Doe" }, "phone": { "description": "User's phone number.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 50, "example": "+12025551234" }, "tax_id": { "type": "string", "format": "tax-id-field", "x-format-message": "tax_id must be 9 digits (dashes optional).", "writeOnly": true, "description": "Tax identification number of the responsible party. Required when tax_id_type is sent. Stored encrypted and not returned in responses.\n", "x-conditionally-required": true, "example": "123-45-6789" }, "tax_id_type": { "type": "string", "enum": [ "ssn", "itin" ], "description": "Type of tax identification number. Required when tax_id is sent.", "x-conditionally-required": true, "example": "ssn" }, "alternate_email": { "description": "User's secondary email address, up to 50 characters.", "type": [ "string", "null" ], "format": "email", "minLength": 3, "maxLength": 50, "example": "jane@example.org" }, "alternate_phone": { "description": "User's secondary phone number.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 50, "example": "+12025555678" }, "fax": { "description": "User's fax number.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 50, "example": "+12025559012" }, "firm": { "description": "The firm the user works for.", "type": [ "object", "null" ], "additionalProperties": false, "minProperties": 1, "properties": { "name": { "description": "Name of the firm.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Doe & Associates" }, "title": { "description": "User's title at the firm.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Partner" } } }, "middle_name": { "description": "User's middle name.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Marie" }, "salutation": { "description": "User's salutation.", "type": [ "string", "null" ], "enum": [ "Mr.", "Miss", "Mrs.", "Ms.", "Dr.", "Prof.", "Rev.", null ], "example": "Ms." }, "suffix": { "description": "User's name suffix.", "type": [ "string", "null" ], "enum": [ "Jr.", "II", "III", "IV", "Sr.", null ], "example": "Jr." } } }, "account": { "description": "Send only to set a partner, a custom account ID or a billing address.", "type": [ "object", "null" ], "additionalProperties": false, "minProperties": 1, "properties": { "billing_address": { "description": "Billing address for the account.", "$ref": "#/components/schemas/StartBusinessAddressInput" }, "custom_account_id": { "description": "Your own identifier for the account, up to 36 characters.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 36, "example": "ACCT-1001" }, "partner_id": { "description": "UUID of the partner the account is created under. Defaults to your own partner.", "type": [ "string", "null" ], "format": "uuid", "minLength": 36, "maxLength": 36 } } } } }, "StartBusinessAddressInput": { "type": [ "object", "null" ], "additionalProperties": false, "required": [ "address_line_1", "locality", "postal_code", "administrative_area", "country" ], "properties": { "address_line_1": { "description": "First line of the street address.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 255, "example": "123 Main St" }, "administrative_area": { "description": "The U.S. state or territory.", "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "description": "UUID of the state or territory.", "type": "string", "format": "uuid", "minLength": 36, "maxLength": 36 } } }, "country": { "description": "The country of the address.", "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "description": "UUID of the country.", "type": "string", "format": "uuid", "minLength": 36, "maxLength": 36 } } }, "locality": { "description": "City or town.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 150, "example": "Washington" }, "postal_code": { "description": "ZIP or postal code.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 20, "example": "20001" }, "address_line_2": { "description": "Second line of the street address, such as a suite or unit.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 255, "example": "Suite 400" } } }, "StartBusinessPrincipalAddressInput": { "type": "object", "additionalProperties": false, "required": [ "address_line_1", "locality", "postal_code", "administrative_area" ], "properties": { "address_line_1": { "description": "First line of the street address.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 255, "example": "123 Main St" }, "administrative_area": { "description": "The U.S. state or territory.", "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "description": "UUID of the state or territory.", "type": "string", "format": "uuid", "minLength": 36, "maxLength": 36 } } }, "locality": { "description": "City or town.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 150, "example": "Washington" }, "postal_code": { "description": "ZIP or postal code.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 20, "example": "20001" }, "address_line_2": { "description": "Second line of the street address, such as a suite or unit.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 255, "example": "Suite 400" } } }, "StartBusinessRegisteredAgentInput": { "type": [ "object", "null" ], "additionalProperties": false, "minProperties": 1, "required": [ "agent_name", "mailing_address" ], "properties": { "agent_name": { "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 255, "description": "Name of the registered agent.", "example": "Example Registered Agents LLC" }, "mailing_address": { "description": "The registered agent's mailing address, in the United States.", "type": "object", "additionalProperties": false, "required": [ "address_line_1", "locality", "postal_code", "administrative_area" ], "properties": { "address_line_1": { "description": "First line of the street address.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 255, "example": "456 Agent Way" }, "administrative_area": { "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "description": "UUID of the state or territory.", "type": "string", "format": "uuid", "minLength": 36, "maxLength": 36 } }, "description": "A U.S. state or territory. The country is always the United\nStates and is not accepted as input.\n" }, "locality": { "description": "City or town.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 255, "example": "Dover" }, "postal_code": { "description": "ZIP or postal code.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 20, "example": "19901" } } } } }, "StartBusinessSharesInput": { "type": [ "object", "null" ], "additionalProperties": false, "required": [ "class_name", "shares_issued" ], "if": { "required": [ "no_series" ], "properties": { "no_series": { "const": true } } }, "then": { "$ref": "#/components/schemas/StartBusinessSharesAuthorizedRule" }, "else": { "$ref": "#/components/schemas/StartBusinessSharesAuthorizedRule", "required": [ "series" ], "properties": { "series": { "type": "string", "format": "not-empty", "minLength": 1 } } }, "properties": { "class_name": { "description": "Name of the share class, such as Common.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 50, "example": "Common" }, "shares_issued": { "description": "Number of shares issued. Can't exceed shares_authorized unless authorized shares are unlimited.", "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1000 }, "has_unlimited_authorized_shares": { "description": "True when the class authorizes unlimited shares. Defaults to false. When false, shares_authorized is required.", "type": [ "boolean", "null" ], "example": false }, "no_par_value": { "description": "True when the shares have no par value. Defaults to false. When false, par_value is required.", "type": [ "boolean", "null" ], "example": false }, "no_series": { "description": "True when the class has no series. Send true to omit series; when false or omitted, series is required.", "type": [ "boolean", "null" ], "example": false }, "par_value": { "description": "Required unless no_par_value is true.", "x-conditionally-required": true, "type": [ "string", "null" ], "minLength": 1, "maxLength": 17, "pattern": "^(\\d{1,10}(\\.\\d{0,6})?|\\.\\d{1,6})$", "x-pattern-message": "Must be a decimal number with up to 10 whole digits and 6 decimal places.", "example": "0.0001" }, "series": { "description": "Required unless no_series is true.", "x-conditionally-required": true, "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 50, "example": "A" }, "shares_authorized": { "description": "Required unless has_unlimited_authorized_shares is true.", "x-conditionally-required": true, "type": [ "integer", "null" ], "minimum": 1, "maximum": 2147483647, "example": 10000 } } }, "StartBusinessSharesAuthorizedRule": { "if": { "required": [ "has_unlimited_authorized_shares" ], "properties": { "has_unlimited_authorized_shares": { "const": true } } }, "then": { "$ref": "#/components/schemas/StartBusinessSharesParValueRule" }, "else": { "$ref": "#/components/schemas/StartBusinessSharesParValueRule", "required": [ "shares_authorized" ], "properties": { "shares_authorized": { "type": "integer" } } } }, "StartBusinessSharesParValueRule": { "if": { "required": [ "no_par_value" ], "properties": { "no_par_value": { "const": true } } }, "else": { "required": [ "par_value" ], "properties": { "par_value": { "type": "string", "format": "not-empty", "minLength": 1 } } } }, "StartBusinessPersonInput": { "type": "object", "additionalProperties": false, "required": [ "first_name", "last_name" ], "properties": { "first_name": { "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 250 }, "middle_name": { "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 250 }, "last_name": { "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 250 } } }, "StartBusinessOfficerInput": { "type": "object", "additionalProperties": false, "required": [ "first_name", "last_name", "officer_title" ], "properties": { "first_name": { "description": "The officer's first name.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Ola" }, "last_name": { "description": "The officer's last name.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Officer" }, "officer_title": { "description": "The officer's title, such as President or Secretary.", "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "description": "UUID of the officer title.", "type": "string", "format": "uuid", "minLength": 36, "maxLength": 36 } } }, "end_date": { "description": "Date the officer left the role, as YYYY-MM-DD.", "type": [ "string", "null" ], "format": "date", "minLength": 10, "maxLength": 10, "example": "2027-01-15" }, "middle_name": { "description": "The officer's middle name.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "J" }, "start_date": { "description": "Date the officer started in the role, as YYYY-MM-DD.", "type": [ "string", "null" ], "format": "date", "minLength": 10, "maxLength": 10, "example": "2026-01-15" } } }, "StartBusinessDirectorInput": { "type": "object", "additionalProperties": false, "required": [ "first_name", "last_name", "director_position" ], "properties": { "director_position": { "description": "The director's position on the board.", "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "description": "UUID of the director position.", "type": "string", "format": "uuid", "minLength": 36, "maxLength": 36 } } }, "first_name": { "description": "The director's first name.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Dee" }, "last_name": { "description": "The director's last name.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Director" }, "end_date": { "description": "Date the director left the role, as YYYY-MM-DD.", "type": [ "string", "null" ], "format": "date", "minLength": 10, "maxLength": 10, "example": "2027-01-15" }, "middle_name": { "description": "The director's middle name.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "J" }, "start_date": { "description": "Date the director started in the role, as YYYY-MM-DD.", "type": [ "string", "null" ], "format": "date", "minLength": 10, "maxLength": 10, "example": "2026-01-15" } } }, "StartBusinessMemberInput": { "type": "object", "additionalProperties": false, "required": [ "first_name", "last_name", "percent_ownership" ], "properties": { "first_name": { "description": "The member's first name.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Jane" }, "last_name": { "description": "The member's last name.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Doe" }, "percent_ownership": { "description": "The member's ownership share as a fraction of 1, for example 0.25 for 25%. Must be greater than 0 and at most 1.", "type": "number", "format": "float", "minimum": 1.0e-5, "maximum": 1, "example": 0.5 }, "amount_paid": { "description": "Amount the member paid for their interest.", "type": [ "number", "null" ], "format": "float", "minimum": 0, "maximum": 99999999999.99, "example": 10000 }, "certificate_number": { "description": "Number on the member's certificate, digits only.", "type": [ "string", "null" ], "minLength": 1, "maxLength": 15, "pattern": "^[0-9]+$", "x-pattern-message": "Must contain digits only.", "example": "1001" }, "middle_name": { "description": "The member's middle name.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "J" } } }, "StartBusinessManagerInput": { "type": "object", "additionalProperties": false, "required": [ "first_name", "last_name", "title" ], "properties": { "first_name": { "description": "The manager's first name.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Sam" }, "last_name": { "description": "The manager's last name.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "Manager" }, "title": { "description": "The manager's title, up to 50 characters.", "type": "string", "format": "not-empty", "minLength": 1, "maxLength": 50, "example": "Managing Member" }, "end_date": { "description": "Date the manager left the role, as YYYY-MM-DD.", "type": [ "string", "null" ], "format": "date", "minLength": 10, "maxLength": 10, "example": "2027-01-15" }, "middle_name": { "description": "The manager's middle name.", "type": [ "string", "null" ], "format": "not-empty", "minLength": 1, "maxLength": 250, "example": "J" }, "start_date": { "description": "Date the manager started in the role, as YYYY-MM-DD.", "type": [ "string", "null" ], "format": "date", "minLength": 10, "maxLength": 10, "example": "2026-01-15" } } }, "ProductRateInput": { "type": "object", "required": [ "ref_product_id" ], "properties": { "ref_product_id": { "type": "integer", "description": "The product this rate applies to" }, "rate": { "type": [ "number", "null" ], "format": "float", "description": "The rate amount (e.g. for SoS products)" }, "initial_rate": { "type": [ "number", "null" ], "format": "float", "description": "Initial rate (e.g. for managed annual license service)" }, "renewal_rate": { "type": [ "number", "null" ], "format": "float", "description": "Renewal rate (e.g. for managed annual license service)" }, "rate_cap": { "type": [ "number", "null" ], "format": "float", "description": "Maximum rate cap" }, "rate_floor": { "type": [ "number", "null" ], "format": "float", "description": "Minimum rate floor" }, "ref_license_type_id": { "type": [ "integer", "null" ], "description": "License type ID, if applicable" }, "ref_license_holder_type_id": { "type": [ "integer", "null" ], "description": "License holder type ID, if applicable" }, "ref_industry_id": { "type": [ "integer", "null" ], "description": "Industry ID, if applicable" } } }, "ProductRateUpdateInput": { "type": "object", "description": "Only rate fields may be patched; all are optional and only provided fields are updated. The product type and all identity/ref fields are immutable \u2014 supplying ref_product_id, account_id, ref_industry_id, ref_license_type_id, ref_license_holder_type_id, or ref_event_type_id is rejected with a 422. For managed annual license service rates only initial_rate/renewal_rate apply; for all other products only rate, rate_cap, and rate_floor apply.\n", "properties": { "rate": { "type": [ "number", "null" ], "format": "float", "description": "The rate amount (e.g. for SoS products)" }, "initial_rate": { "type": [ "number", "null" ], "format": "float", "description": "Initial rate (e.g. for managed annual license service)" }, "renewal_rate": { "type": [ "number", "null" ], "format": "float", "description": "Renewal rate (e.g. for managed annual license service)" }, "rate_cap": { "type": [ "number", "null" ], "format": "float", "description": "Maximum rate cap. For fundraising rates the base rate must already be set before the cap can be patched.\n" }, "rate_floor": { "type": [ "number", "null" ], "format": "float", "description": "Minimum rate floor. For fundraising rates the base rate must already be set before the floor can be patched.\n" } } }, "AccountUserInput": { "type": "object", "description": "Creates either a portal user or an Individual. When has_portal_access is true (the default), email and permission_level are required and the user is set up with account access. When has_portal_access is false, an Individual is created: a person who can be named on a record book and on filings but never logs in. In that case email is optional and permission_level, invite, is_fulfillment_contact, has_billing_access, notifications and companies must not be sent.\n", "required": [ "first_name", "last_name" ], "properties": { "has_portal_access": { "type": "boolean", "default": true, "description": "Whether this person gets portal access. Set to false to create an Individual with no login. Omitting the field creates a portal user.\n" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string", "format": "email", "description": "Required when has_portal_access is true; optional for an Individual.\n" }, "salutation": { "type": "string", "enum": [ "Mr.", "Miss", "Mrs.", "Ms.", "Dr.", "Prof.", "Rev." ], "description": "Salutation for the user" }, "suffix": { "type": "string", "enum": [ "Jr.", "II", "III", "IV", "Sr." ], "description": "Suffix for the user" }, "phone": { "type": "string" }, "phone_2": { "type": "string" }, "fax": { "type": "string" }, "address": { "type": "object", "properties": { "address_line_1": { "type": "string" }, "address_line_2": { "type": "string" }, "locality": { "type": "string" }, "administrative_area": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } }, "country": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } }, "postal_code": { "type": "string" } } }, "permission_level": { "type": "string", "format": "uuid", "description": "UUID of an account-level user role. Use the /user-roles endpoint to list valid roles. Non-account-level role UUIDs will be rejected.\n" }, "is_fulfillment_contact": { "type": "boolean", "default": false }, "has_billing_access": { "type": "boolean", "default": false }, "invite": { "type": "boolean", "default": false, "description": "Whether to send an invitation email to the user" }, "notifications": { "type": "object", "properties": { "ra_service_of_process": { "type": "boolean" }, "ra_regular_mail": { "type": "boolean" }, "annual_report": { "type": "boolean" }, "billing": { "type": "boolean" }, "compliance_report_monthly": { "type": "boolean" }, "compliance_report_weekly": { "type": "boolean" } } }, "companies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the company" }, "billing_access": { "type": "boolean" }, "is_attorney": { "type": "boolean" }, "is_accountant": { "type": "boolean" }, "title_description": { "type": "string" }, "notifications": { "type": "object", "properties": { "ra_service_of_process": { "type": "boolean" }, "ra_regular_mail": { "type": "boolean" }, "annual_report": { "type": "boolean" }, "billing": { "type": "boolean" } } } } } } } }, "AccountUserUpdateInput": { "type": "object", "description": "All fields are optional. Only provided fields will be updated.", "properties": { "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "salutation": { "type": [ "string", "null" ], "enum": [ "Mr.", "Miss", "Mrs.", "Ms.", "Dr.", "Prof.", "Rev.", "", null ], "description": "Salutation for the user. Send an empty string to clear.\n" }, "suffix": { "type": [ "string", "null" ], "enum": [ "Jr.", "II", "III", "IV", "Sr.", "", null ], "description": "Suffix for the user. Send an empty string to clear.\n" }, "phone": { "type": "string" }, "phone_2": { "type": "string" }, "fax": { "type": "string" }, "address": { "type": [ "object", "null" ], "description": "Home address. Send an empty object or null to clear the existing address.\n", "properties": { "address_line_1": { "type": "string" }, "address_line_2": { "type": "string" }, "locality": { "type": "string" }, "administrative_area": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } }, "country": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } }, "postal_code": { "type": "string" } } }, "permission_level": { "type": "string", "format": "uuid", "description": "UUID of an account-level user role. Use the /user-roles endpoint to list valid roles. Non-account-level role UUIDs will be rejected. Required when has_portal_access is true; must be omitted when it is false, in which case the Individual role is assigned automatically.\n" }, "is_fulfillment_contact": { "type": "boolean" }, "has_billing_access": { "type": "boolean" } } }, "AccountTagInput": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID of the tag to assign to the account. Use the /tags endpoint to list valid tags." } } }, "OrderDatesInput": { "type": "object", "description": "Partial dates update. All fields are optional \u2014 fields omitted from the request body are left at their current value.\n", "properties": { "order_date": { "type": [ "string", "null" ], "format": "date-time", "description": "ISO 8601 datetime with timezone offset (Z or \u00b1HH:MM); empty string or null clears the value" }, "paid_date": { "type": [ "string", "null" ], "format": "date-time", "description": "ISO 8601 datetime with timezone offset (Z or \u00b1HH:MM); empty string or null clears the value" } } }, "OrderSubscriptionTermInput": { "type": "object", "description": "Partial subscription-term update. All fields are optional \u2014 fields omitted from the request body are left at their current value.\n", "properties": { "billing_cycle_years": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 12, "description": "Length of the billing cycle in years; empty string or null clears the value" }, "subscription_start_date": { "type": [ "string", "null" ], "format": "date", "description": "YYYY-MM-DD; empty string or null clears the value" }, "subscription_end_date": { "type": [ "string", "null" ], "format": "date", "description": "YYYY-MM-DD; must be after subscription_start_date when both are sent; empty string or null clears the value" } } }, "OrderFeesInput": { "type": "object", "description": "Partial fee update. All fields are optional \u2014 fields omitted from the request body are left at their current value.\n", "properties": { "service_fee_original": { "type": "number", "format": "float" }, "service_fee_late_fee": { "type": "number", "format": "float" }, "service_fee_partner": { "type": "number", "format": "float" }, "service_fee_discount": { "type": "number", "format": "float" }, "service_fee_expedite": { "type": "number", "format": "float" }, "government_fee": { "type": "number", "format": "float" }, "filing_agency_late_fee": { "type": "number", "format": "float" }, "filing_penalty_fee": { "type": "number", "format": "float" }, "cogs_correspondent": { "type": "number", "format": "float" }, "cogs_publishing": { "type": "number", "format": "float" }, "cogs_nw": { "type": "number", "format": "float" }, "cogs_other": { "type": "number", "format": "float" } } }, "RefJurisdictionWritableFields": { "type": "object", "description": "Fields accepted when creating or updating a reference jurisdiction.", "properties": { "name": { "type": "string", "maxLength": 255 }, "localized_name": { "type": [ "string", "null" ], "maxLength": 255 }, "abbreviation": { "type": [ "string", "null" ], "maxLength": 50 }, "lower": { "type": [ "string", "null" ], "maxLength": 100 }, "capital": { "type": [ "string", "null" ], "maxLength": 100 }, "formal": { "type": [ "string", "null" ], "maxLength": 250 }, "article": { "type": [ "string", "null" ], "maxLength": 5 }, "iso": { "type": [ "string", "null" ], "maxLength": 255 }, "iso_2": { "type": [ "string", "null" ], "maxLength": 255 }, "iso_3": { "type": [ "string", "null" ], "maxLength": 255 }, "is_permissible_domicile": { "type": [ "boolean", "null" ] }, "ref_geographic_unit": { "$ref": "#/components/schemas/RefJurisdictionRelationInput" } } }, "RefJurisdictionInput": { "allOf": [ { "$ref": "#/components/schemas/RefJurisdictionWritableFields" }, { "type": "object", "description": "Request body for creating a reference jurisdiction.", "required": [ "name", "ref_geographic_unit" ], "properties": { "parent_jurisdiction": { "$ref": "#/components/schemas/RefJurisdictionRelationInput" } } } ] }, "RefJurisdictionUpdateInput": { "allOf": [ { "$ref": "#/components/schemas/RefJurisdictionWritableFields" }, { "type": "object", "description": "Request body for updating a reference jurisdiction. All fields are optional; only provided fields are modified. The parent jurisdiction cannot be changed here \u2014 it is set when the jurisdiction is created." } ] }, "RefJurisdictionRelationInput": { "type": "object", "description": "Reference to a related entity, identified by UUID.", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } }, "RefLicenseUpdateInput": { "type": "object", "description": "Request body for updating a reference license. All fields are optional; only provided fields are modified.\n", "properties": { "name": { "type": "string", "maxLength": 255 }, "ref_jurisdiction": { "$ref": "#/components/schemas/RefLicenseRelationInput" }, "ref_license_holder_type": { "$ref": "#/components/schemas/RefLicenseRelationInput" }, "ref_filing_authority": { "$ref": "#/components/schemas/RefLicenseRelationInput" }, "introduction": { "type": [ "string", "null" ] }, "not_required": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ] }, "legal_notes": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] }, "fact_checked": { "type": [ "string", "null" ], "format": "date" }, "classifications": { "type": [ "string", "null" ] }, "bond_amount": { "type": [ "string", "null" ] }, "requirement_notes": { "type": [ "string", "null" ] }, "foreign_qualification_required": { "type": [ "boolean", "null" ] }, "registered_agent_special_agency_required": { "type": [ "boolean", "null" ] }, "disclosure_details": { "type": [ "string", "null" ] }, "disclosure_required": { "type": [ "string", "null" ] }, "is_qualifying_individual_license_required": { "type": [ "boolean", "null" ] }, "qualifying_individual_requirements": { "type": [ "string", "null" ] }, "ownership_requirements": { "type": [ "string", "null" ] }, "entity_requirements": { "type": [ "string", "null" ] }, "is_exam_required": { "type": [ "boolean", "null" ] }, "employee_only_notes": { "type": [ "string", "null" ] }, "make_check_payable_to": { "type": [ "string", "null" ], "maxLength": 255 }, "legal_notes_vp_id": { "type": [ "integer", "null" ] }, "foreign_qualification_required_vp_id": { "type": [ "integer", "null" ] }, "registered_agent_special_agency_required_vp_id": { "type": [ "integer", "null" ] }, "not_required_vp_id": { "type": [ "integer", "null" ] } } }, "RefLicenseRelationInput": { "type": "object", "description": "Reference to a related entity, identified by UUID.", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } }, "RefCsrAuditThresholdInput": { "type": "object", "description": "Request body for creating a reference CSR audit threshold. A jurisdiction can have only one threshold.\n", "required": [ "ref_jurisdiction", "audit_required" ], "properties": { "ref_jurisdiction": { "$ref": "#/components/schemas/RefCsrAuditThresholdRelationInput" }, "audit_required": { "type": "boolean" }, "audit_threshold": { "type": [ "string", "null" ], "description": "HTML fragment." }, "review_threshold": { "type": [ "string", "null" ], "description": "HTML fragment." }, "notes": { "type": [ "string", "null" ], "description": "HTML fragment." }, "fact_checked": { "type": [ "string", "null" ], "format": "date", "description": "Date in `YYYY-MM-DD` format; cannot be in the future." } } }, "RefCsrAuditThresholdUpdateInput": { "type": "object", "description": "Request body for updating a reference CSR audit threshold. Only fields present in the body are modified.\n", "properties": { "ref_jurisdiction": { "$ref": "#/components/schemas/RefCsrAuditThresholdRelationInput" }, "audit_required": { "type": "boolean" }, "audit_threshold": { "type": [ "string", "null" ], "description": "HTML fragment." }, "review_threshold": { "type": [ "string", "null" ], "description": "HTML fragment." }, "notes": { "type": [ "string", "null" ], "description": "HTML fragment." }, "fact_checked": { "type": [ "string", "null" ], "format": "date", "description": "Date in `YYYY-MM-DD` format; cannot be in the future." } } }, "RefCsrAuditThresholdRelationInput": { "type": "object", "description": "Reference to a related entity, identified by UUID.", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } }, "RefFilingAuthorityStatusInput": { "type": "object", "description": "Request body for creating a reference filing authority status.", "required": [ "status_description" ], "properties": { "status_description": { "type": "string", "maxLength": 65535 }, "status_start_date": { "type": [ "string", "null" ], "format": "date-time", "description": "ISO 8601 datetime, e.g. `2026-03-01T00:00:00Z`." }, "status_end_date": { "type": [ "string", "null" ], "format": "date-time", "description": "ISO 8601 datetime; omit for an open-ended status." }, "ref_filing_authority": { "$ref": "#/components/schemas/RefFilingAuthorityStatusRelationInput" }, "ref_jurisdiction": { "$ref": "#/components/schemas/RefFilingAuthorityStatusRelationInput" }, "ref_filing_authority_status_group": { "$ref": "#/components/schemas/RefFilingAuthorityStatusRelationInput" } } }, "RefFilingAuthorityStatusUpdateInput": { "type": "object", "description": "Request body for updating a reference filing authority status. Only fields present in the body are modified.\n", "properties": { "status_description": { "type": [ "string", "null" ], "maxLength": 65535 }, "status_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "status_end_date": { "type": [ "string", "null" ], "format": "date-time" }, "ref_filing_authority": { "$ref": "#/components/schemas/RefFilingAuthorityStatusRelationInput" }, "ref_jurisdiction": { "$ref": "#/components/schemas/RefFilingAuthorityStatusRelationInput" }, "ref_filing_authority_status_group": { "$ref": "#/components/schemas/RefFilingAuthorityStatusRelationInput" } } }, "RefFilingAuthorityStatusRelationInput": { "type": "object", "description": "Reference to a related entity, identified by UUID.", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } }, "RefLicenseTypeUpdateInput": { "type": "object", "description": "Request body for updating a global reference license type. Only fields present in the body are modified.\n", "properties": { "name": { "type": "string", "maxLength": 255 }, "ref_module": { "$ref": "#/components/schemas/RefLicenseTypeRelationInput" }, "ref_license_holder_type": { "$ref": "#/components/schemas/RefLicenseTypeRelationInput" }, "ref_industry": { "$ref": "#/components/schemas/RefLicenseTypeRelationInput" }, "description": { "type": [ "string", "null" ] }, "active": { "type": [ "boolean", "null" ] } } }, "RefLicenseTypeRelationInput": { "type": "object", "description": "Reference to a related entity, identified by UUID.", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } }, "RefFilingWritableFields": { "type": "object", "description": "Fields accepted when creating or updating a reference filing.", "properties": { "name": { "type": [ "string", "null" ], "maxLength": 255 }, "local_name": { "type": [ "string", "null" ], "maxLength": 250 }, "introduction": { "type": [ "string", "null" ] }, "form": { "type": [ "string", "null" ] }, "instructions": { "type": [ "string", "null" ] }, "filing_method": { "type": [ "string", "null" ] }, "default_assignee_id": { "type": [ "integer", "null" ] }, "filing_window_length": { "type": [ "integer", "null" ] }, "turnaround": { "type": [ "string", "null" ] }, "law": { "type": [ "string", "null" ] }, "fee_description": { "type": [ "string", "null" ] }, "is_fee_fixed": { "type": [ "boolean", "null" ] }, "due_date_description": { "type": [ "string", "null" ] }, "renewal_interval": { "type": [ "integer", "null" ] }, "renewal_interval_date_unit_id": { "type": [ "integer", "null" ] }, "penalties": { "type": [ "string", "null" ] }, "original_ink": { "type": [ "boolean", "null" ] }, "notarize": { "type": [ "boolean", "null" ] }, "tax_clearance": { "type": [ "boolean", "null" ] }, "fact_checked": { "type": [ "string", "null" ], "format": "date" }, "custom_1": { "type": [ "string", "null" ] }, "custom_2": { "type": [ "string", "null" ] }, "custom_3": { "type": [ "string", "null" ] }, "custom_b_4": { "type": [ "boolean", "null" ] }, "custom_b5": { "type": [ "boolean", "null" ] }, "custom_b6": { "type": [ "boolean", "null" ] }, "custom_b7": { "type": [ "boolean", "null" ] }, "custom_b8": { "type": [ "boolean", "null" ] }, "custom_b9": { "type": [ "boolean", "null" ] }, "custom_b10": { "type": [ "boolean", "null" ] }, "custom_b11": { "type": [ "boolean", "null" ] }, "custom_b12": { "type": [ "boolean", "null" ] }, "custom_b13": { "type": [ "boolean", "null" ] }, "custom_b14": { "type": [ "boolean", "null" ] }, "custom_b15": { "type": [ "boolean", "null" ] }, "custom_16": { "type": [ "string", "null" ] }, "custom_17": { "type": [ "string", "null" ] }, "custom_18": { "type": [ "string", "null" ] }, "custom_19": { "type": [ "string", "null" ] }, "custom_20": { "type": [ "string", "null" ] }, "not_required": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ] }, "employee_only_notes": { "type": [ "string", "null" ] }, "credential_requirements": { "type": [ "string", "null" ] }, "proof_of_filing": { "type": [ "string", "null" ] }, "proof_of_filing_standard": { "type": [ "string", "null" ] }, "fee_to_invoice": { "type": [ "number", "null" ], "format": "double" }, "bond_amount": { "type": [ "string", "null" ] }, "accepts_urs": { "type": [ "boolean", "null" ] }, "background_check_requirements": { "type": [ "string", "null" ] }, "filing_requirements": { "type": [ "string", "null" ] }, "exemption_eligible_organizations": { "type": [ "string", "null" ] }, "registered_agent_requirements": { "type": [ "string", "null" ] }, "agent_requirements": { "type": [ "string", "null" ] }, "order_of_operations": { "type": [ "string", "null" ] }, "required_attachments": { "type": [ "string", "null" ] }, "due_date_extension": { "type": [ "string", "null" ] }, "extension_is_available": { "type": [ "boolean", "null" ] }, "extension_is_automatic": { "type": [ "boolean", "null" ] }, "extension_requires_a_8868": { "type": [ "boolean", "null" ] }, "extension_interval": { "type": [ "integer", "null" ] }, "extension_interval_date_unit_id": { "type": [ "integer", "null" ] }, "second_extension_is_available": { "type": [ "boolean", "null" ] }, "second_extension_is_automatic": { "type": [ "boolean", "null" ] }, "second_extension_requires_a_8868": { "type": [ "boolean", "null" ] }, "second_extension_interval": { "type": [ "integer", "null" ] }, "second_extension_interval_date_unit_id": { "type": [ "integer", "null" ] }, "make_check_payable_to": { "type": [ "string", "null" ], "maxLength": 255 }, "electronic_signature_allowed": { "type": [ "boolean", "null" ] }, "client_signature_required": { "type": [ "boolean", "null" ] }, "agent_signature_required": { "type": [ "boolean", "null" ] }, "power_of_attorney_accepted": { "type": [ "boolean", "null" ] }, "sign_in_app_msg": { "type": [ "string", "null" ] }, "post_filing_msg_txt": { "type": [ "string", "null" ] }, "ref_credential_type_id": { "type": [ "integer", "null" ] }, "traffic_cop_badge": { "type": [ "string", "null" ] }, "traffic_cop_tooltip": { "type": [ "string", "null" ] }, "turnaround_interval_start": { "type": [ "integer", "null" ] }, "turnaround_interval_end": { "type": [ "integer", "null" ] }, "turnaround_interval_date_unit_id": { "type": [ "integer", "null" ] }, "form_vp_id": { "type": [ "integer", "null" ] }, "filing_method_vp_id": { "type": [ "integer", "null" ] }, "filing_window_length_vp_id": { "type": [ "integer", "null" ] }, "fee_description_vp_id": { "type": [ "integer", "null" ] }, "due_date_description_vp_id": { "type": [ "integer", "null" ] }, "due_date_extension_vp_id": { "type": [ "integer", "null" ] }, "not_required_vp_id": { "type": [ "integer", "null" ] }, "post_filing_approval_required": { "type": [ "boolean", "null" ] }, "extension_shifts_filing_window": { "type": [ "boolean", "null" ] }, "workspace_manual_filing": { "type": [ "boolean", "null" ] }, "manual_filing": { "type": [ "boolean", "null" ] }, "can_renew_if_delinquent": { "type": [ "boolean", "null" ] }, "can_use_past_tax_year_financials": { "type": [ "boolean", "null" ] }, "number_of_past_tax_years_to_check": { "type": [ "integer", "null" ] }, "require_registration_license_number": { "type": [ "boolean", "null" ] }, "brand_credentials_required": { "type": [ "boolean", "null" ] }, "extension_filing_window_length": { "type": [ "integer", "null" ] }, "ref_jurisdiction": { "$ref": "#/components/schemas/RefFilingRelationInput" }, "ref_product": { "$ref": "#/components/schemas/RefFilingRelationInput" }, "ref_entity": { "$ref": "#/components/schemas/RefFilingRelationInput" }, "ref_registration_type": { "$ref": "#/components/schemas/RefFilingRelationInput" }, "ref_event_type": { "$ref": "#/components/schemas/RefFilingRelationInput" }, "ref_filing_authority": { "$ref": "#/components/schemas/RefFilingRelationInput" }, "ref_harbor_compliance_filing_method": { "$ref": "#/components/schemas/RefFilingRelationInput" }, "extension_filing_method": { "$ref": "#/components/schemas/RefFilingRelationInput" }, "second_extension_filing_method": { "$ref": "#/components/schemas/RefFilingRelationInput" }, "ref_license_type": { "$ref": "#/components/schemas/RefFilingRelationInput" }, "ref_license": { "$ref": "#/components/schemas/RefFilingRelationInput" } } }, "RefFilingInput": { "allOf": [ { "$ref": "#/components/schemas/RefFilingWritableFields" }, { "type": "object", "required": [ "ref_jurisdiction" ] } ] }, "RefFilingUpdateInput": { "allOf": [ { "$ref": "#/components/schemas/RefFilingWritableFields" } ] }, "RefFilingRelationInput": { "type": "object", "description": "Reference to a related entity, identified by UUID.", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } }, "RefFilingAuthorityWritableFields": { "type": "object", "description": "Fields accepted when creating or updating a global reference filing authority. The owning account, the `extensions` blob, the VisualPing monitoring ids and the audit columns are not writable through the API.\n", "properties": { "name": { "type": [ "string", "null" ], "maxLength": 255 }, "slug": { "type": [ "string", "null" ], "maxLength": 250 }, "ref_jurisdiction": { "$ref": "#/components/schemas/RefFilingAuthorityRelationInput" }, "type_corporate_registrar": { "type": [ "boolean", "null" ] }, "type_rev": { "type": [ "boolean", "null" ] }, "type_charity": { "type": [ "boolean", "null" ] }, "type_licensing": { "type": [ "boolean", "null" ] }, "requires_registered_agent_id": { "type": [ "boolean", "null" ], "description": "Whether the agency requires a registered agent identifier on filings. A boolean despite the `_id` suffix, which matches the column name." }, "is_commercial_registered_agent": { "type": [ "boolean", "null" ] }, "phone": { "type": [ "string", "null" ], "maxLength": 100 }, "fax": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "web": { "type": [ "string", "null" ], "maxLength": 255 }, "physical_address_street1": { "type": [ "string", "null" ], "maxLength": 255 }, "physical_address_street2": { "type": [ "string", "null" ], "maxLength": 255 }, "physical_address_city": { "type": [ "string", "null" ], "maxLength": 100 }, "physical_address_state": { "type": [ "string", "null" ], "maxLength": 100 }, "physical_address_zip": { "type": [ "string", "null" ], "maxLength": 50 }, "mailing_address_name": { "type": [ "string", "null" ], "maxLength": 255 }, "mailing_address_street1": { "type": [ "string", "null" ], "maxLength": 255 }, "mailing_address_street2": { "type": [ "string", "null" ], "maxLength": 255 }, "mailing_address_city": { "type": [ "string", "null" ], "maxLength": 100 }, "mailing_address_state": { "type": [ "string", "null" ], "maxLength": 100 }, "mailing_address_zip": { "type": [ "string", "null" ], "maxLength": 50 }, "notes": { "type": [ "string", "null" ] }, "url_name_search": { "type": [ "string", "null" ] }, "url_forms": { "type": [ "string", "null" ] }, "url_online_filing": { "type": [ "string", "null" ] }, "company_registration_search_url": { "type": [ "string", "null" ] }, "individual_search_url": { "type": [ "string", "null" ] }, "filing_tips": { "type": [ "string", "null" ] }, "search_tips": { "type": [ "string", "null" ] }, "contact_first_name": { "type": [ "string", "null" ], "maxLength": 250 }, "contact_last_name": { "type": [ "string", "null" ], "maxLength": 250 }, "contact_phone": { "type": [ "string", "null" ], "maxLength": 250 }, "contact_phone2": { "type": [ "string", "null" ], "maxLength": 250 }, "contact_fax": { "type": [ "string", "null" ], "maxLength": 250 }, "contact_email": { "type": [ "string", "null" ], "maxLength": 255 }, "fact_checked": { "type": [ "string", "null" ], "format": "date" } } }, "RefFilingAuthorityInput": { "allOf": [ { "$ref": "#/components/schemas/RefFilingAuthorityWritableFields" }, { "type": "object", "required": [ "name", "ref_jurisdiction" ] } ] }, "RefFilingAuthorityUpdateInput": { "allOf": [ { "$ref": "#/components/schemas/RefFilingAuthorityWritableFields" } ], "description": "All fields are optional; only provided fields are modified." }, "RefFilingAuthorityRelationInput": { "type": "object", "description": "Reference to a related entity, identified by UUID.", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } }, "RefEventTypeInput": { "type": "object", "description": "An event type reference. Use the /ref-licenses/event-types endpoint to look up valid IDs.\n", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID of the event type" } }, "required": [ "id" ] }, "EventAssigneeInput": { "type": "object", "description": "A user reference for assigning an event. Must be a user belonging to the account.", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID of the user" } }, "required": [ "id" ] }, "EventInput": { "type": "object", "description": "Payload for creating a compliance event under a license.\n`frequency` determines how the event recurs: `one_time`, `annual`, `biennial`, or `custom`. When `custom`, `renewal_interval` and `renewal_interval_unit` are required.\n", "properties": { "name": { "type": "string", "maxLength": 255, "description": "The name of the event" }, "ref_event_type": { "$ref": "#/components/schemas/RefEventTypeInput" }, "due_date": { "type": "string", "format": "date", "description": "The event's due date (YYYY-MM-DD)" }, "due_date_override": { "type": "string", "format": "date", "description": "An extended/overridden due date (YYYY-MM-DD)" }, "frequency": { "type": "string", "enum": [ "one_time", "annual", "biennial", "custom" ], "description": "How often the event recurs" }, "renewal_interval": { "type": "integer", "description": "Required when frequency is `custom`. The numeric recurrence interval." }, "renewal_interval_unit": { "type": "string", "enum": [ "day", "month", "quarter", "week" ], "description": "Required when frequency is `custom`. The unit for renewal_interval." }, "assignees": { "type": "array", "description": "Users to assign to the event. Each must belong to the account.", "items": { "$ref": "#/components/schemas/EventAssigneeInput" } }, "state_fee": { "type": "number", "format": "float", "description": "The filing fee for this event" }, "state_fee_override": { "type": "number", "format": "float", "description": "An overridden filing fee" } }, "required": [ "name", "ref_event_type", "due_date", "frequency" ] }, "EventUpdate": { "type": "object", "description": "Payload for updating a compliance event. All fields are optional; only provided fields will be updated. Managed events cannot be edited; a completed event's filing fee cannot be changed unless the caller is a billing admin.\n", "properties": { "name": { "type": "string", "maxLength": 255, "description": "The name of the event" }, "ref_event_type": { "$ref": "#/components/schemas/RefEventTypeInput" }, "due_date": { "type": "string", "format": "date", "description": "The event's due date (YYYY-MM-DD)" }, "due_date_override": { "type": "string", "format": "date", "description": "An extended/overridden due date (YYYY-MM-DD)" }, "frequency": { "type": "string", "enum": [ "one_time", "annual", "biennial", "custom" ], "description": "How often the event recurs" }, "renewal_interval": { "type": "integer", "description": "The numeric recurrence interval, when frequency is `custom`." }, "renewal_interval_unit": { "type": "string", "enum": [ "day", "month", "quarter", "week" ], "description": "The unit for renewal_interval, when frequency is `custom`." }, "assignees": { "type": "array", "description": "Users to assign to the event. Each must belong to the account.", "items": { "$ref": "#/components/schemas/EventAssigneeInput" } }, "state_fee": { "type": "number", "format": "float", "description": "The filing fee for this event" }, "state_fee_override": { "type": "number", "format": "float", "description": "An overridden filing fee" } } }, "RefRegisteredAgentAddressWritableFields": { "type": "object", "description": "Fields accepted when creating or updating a reference registered agent address. The audit columns are not writable through the API.\n", "properties": { "name": { "type": [ "string", "null" ], "maxLength": 200 }, "ref_jurisdiction": { "$ref": "#/components/schemas/RefRegisteredAgentAddressRelationInput" }, "address_line1": { "type": "string", "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 200 }, "state": { "type": "string", "maxLength": 100 }, "zip": { "type": [ "string", "null" ], "maxLength": 200 }, "county": { "type": [ "string", "null" ], "maxLength": 200 }, "notes": { "type": "string" }, "phone": { "type": [ "string", "null" ], "maxLength": 255 }, "fax": { "type": [ "string", "null" ], "maxLength": 255 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "registered_agent_id": { "type": [ "string", "null" ], "maxLength": 9, "description": "State-assigned registered agent identifier. Required when the jurisdiction has a filing authority flagged as requiring one." }, "is_commercial_registered_agent": { "type": [ "boolean", "null" ] } } }, "RefRegisteredAgentAddressInput": { "allOf": [ { "$ref": "#/components/schemas/RefRegisteredAgentAddressWritableFields" }, { "type": "object", "required": [ "ref_jurisdiction", "address_line1", "state", "notes" ] } ] }, "RefRegisteredAgentAddressUpdateInput": { "allOf": [ { "$ref": "#/components/schemas/RefRegisteredAgentAddressWritableFields" } ], "description": "All fields are optional; only provided fields are modified." }, "RefRegisteredAgentAddressRelationInput": { "type": "object", "description": "Reference to a related entity, identified by UUID.", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } }, "RefFilingsColumnConfigWritableFields": { "type": "object", "description": "Fields accepted when creating or updating a reference filings column config. Changes take effect on filing pages immediately.\n", "properties": { "label": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "harbor_only": { "type": "boolean", "description": "Must be a JSON boolean. When true, the field is hidden from non-employees." }, "is_premium_data": { "type": "boolean", "description": "Must be a JSON boolean. When true, the field is behind the premium-data paywall on license filings." }, "display_on_work_it_screen": { "type": "boolean", "description": "Must be a JSON boolean." }, "display_sort_order": { "type": [ "integer", "null" ] }, "render_function": { "type": [ "string", "null" ], "description": "Render function used to format the field's value. Any other value is rejected. Some functions only support specific columns: `printDateUnit` (`renewal_interval_date_unit_id`, `extension_interval_date_unit_id`, `second_extension_interval_date_unit_id`, `turnaround_interval_date_unit_id`), `printExtensionFilingMethod` (`extension_filing_method`, `second_extension_filing_method`), `printExtensionInterval` (`extension_interval`, `second_extension_interval`) and `printTurnaroundInterval` (`turnaround_interval_start`, `turnaround_interval_end`). On update, the render function is checked against the saved `column_name`.\n", "enum": [ "printAgency", "printBoolean", "printBooleanRequired", "printCredentialType", "printCurrency", "printDateUnit", "printDefaultAssignee", "printDefaultText", "printEntity", "printEventType", "printExtensionFilingMethod", "printExtensionInterval", "printHarborComplianceFilingMethod", "printIdAndHyperlinks", "printIntegerOrNotSet", "printIrs8868Required", "printJurisdiction", "printLicenseType", "printLocalName", "printNotarize", "printNotRequiredField", "printNumberOfPastTaxYears", "printProduct", "printRegistration", "printRegistrationType", "printTurnaroundInterval", null ] }, "default_text": { "type": [ "string", "null" ] } } }, "RefFilingsColumnConfigInput": { "allOf": [ { "$ref": "#/components/schemas/RefFilingsColumnConfigWritableFields" }, { "type": "object", "description": "Leave all three scope relations out to create a default row. The three flags are required so an override never falls back to column defaults. `column_name` must be a ref filing field (or a field that already has a default row) and unique within its scope. A `ref_event_type` override only applies together with a `ref_license_type`, so sending one without the other is rejected. A `ref_product` override cannot be combined with a license type or event type; create separate rows instead. Relation ids must be UUID strings. The flat `ref_license_type_id`, `ref_event_type_id` and `ref_product_id` keys are rejected with 422.\n", "properties": { "column_name": { "type": "string" }, "ref_license_type": { "$ref": "#/components/schemas/RefFilingsColumnConfigRelationInput" }, "ref_event_type": { "$ref": "#/components/schemas/RefFilingsColumnConfigRelationInput" }, "ref_product": { "$ref": "#/components/schemas/RefFilingsColumnConfigRelationInput" } }, "required": [ "column_name", "harbor_only", "is_premium_data", "display_on_work_it_screen" ] } ] }, "RefFilingsColumnConfigUpdateInput": { "allOf": [ { "$ref": "#/components/schemas/RefFilingsColumnConfigWritableFields" } ], "description": "All fields are optional; only provided fields are modified. `column_name` and the scope relations (nested or as flat `*_id` keys) cannot be changed \u2014 sending them returns 422. Create a new row instead." }, "RefFilingsColumnConfigRelationInput": { "type": "object", "description": "Reference to a related entity, identified by UUID.", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } }, "RefRegistrationStatusMappingWritableFields": { "type": "object", "description": "Fields accepted when creating or updating a reference registration status mapping. `approved_by` and the audit columns are not writable through the API; approving a mapping records the caller as the approver.\n", "properties": { "ref_jurisdiction": { "$ref": "#/components/schemas/RefRegistrationStatusMappingRelationInput" }, "ref_registration_status_group": { "$ref": "#/components/schemas/RefRegistrationStatusMappingRelationInput" }, "ref_license": { "$ref": "#/components/schemas/RefRegistrationStatusMappingRelationInput" }, "incoming_status": { "type": "string", "maxLength": 255 }, "approved": { "type": "boolean", "description": "Must be a JSON boolean." }, "notes": { "type": "string", "maxLength": 65535, "nullable": true } } }, "RefRegistrationStatusMappingInput": { "allOf": [ { "$ref": "#/components/schemas/RefRegistrationStatusMappingWritableFields" }, { "type": "object", "required": [ "ref_jurisdiction", "incoming_status" ] } ] }, "RefRegistrationStatusMappingUpdateInput": { "allOf": [ { "$ref": "#/components/schemas/RefRegistrationStatusMappingWritableFields" } ], "description": "All fields are optional; only provided fields are modified." }, "RefRegistrationStatusMappingRelationInput": { "type": "object", "description": "Reference to a related entity, identified by UUID.", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } }, "CommentInput": { "type": "object", "required": [ "body" ], "properties": { "body": { "type": "string", "maxLength": 10000, "description": "The comment body. Must not be blank." } } } }, "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" } } } } } } } } }, "FeatureNotEnabled": { "description": "Feature not enabled for this account", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "feature_not_enabled" }, "message": { "type": "string", "example": "Records Manager is not enabled for this account. Contact Harbor Compliance to enable this feature." }, "feature": { "type": "string", "example": "records_manager_access" } } } } } }, "RateLimitExceeded": { "description": "Rate limit exceeded", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "rate_limit_exceeded" }, "message": { "type": "string", "example": "Rate limit exceeded. Try again in 30 seconds." }, "retry_after": { "type": "integer", "example": 30 } } } } } }, "IdempotencyConflict": { "description": "The `Idempotency-Key` was already used with a different request, or a request with the same key is still being processed. See the Idempotency section of this documentation.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "A request with this Idempotency-Key is already being processed." }, "errors": { "type": "object", "properties": { "idempotency_key": { "type": "array", "items": { "type": "string" }, "example": [ "Retry after a short delay to receive the original response." ] } } } } } } } } }, "headers": { "RateLimitLimit": { "description": "Maximum number of tokens (burst capacity) for the bucket.", "schema": { "type": "integer" } }, "RateLimitRemaining": { "description": "Tokens remaining in the bucket.", "schema": { "type": "integer" } }, "RateLimitReset": { "description": "Unix timestamp when the bucket is fully refilled.", "schema": { "type": "integer" } } }, "securitySchemes": { "Oauth2": { "type": "oauth2", "x-default-scopes": [ "admin" ], "flows": { "authorizationCode": { "authorizationUrl": "/api/v3/oauth/authorize", "tokenUrl": "/api/v3/oauth/access_token", "x-usePkce": "no", "x-scalar-credentials-location": "body", "scopes": { "admin": "Full access to the Harbor Compliance API" } } } }, "ClientCredentials": { "type": "oauth2", "description": "Client credentials grant for server-to-server integrations. Access is governed by the client's capabilities, so no scopes are requested.\n", "flows": { "clientCredentials": { "tokenUrl": "/api/v3/oauth/access_token", "x-scalar-credentials-location": "body", "scopes": {} } } } } } }