Compliance API Overview

🚧

Limited Availability

Access to the Compliance API is currently limited to approved partners. Endpoints, request/response shapes, and field names may change before reaching general availability — use against staging for early integration work and coordinate with your CorpNet account manager before relying on Compliance API calls in production-critical paths. Report issues or feedback to your account manager.

The CorpNet Compliance API provides RESTful endpoints for managing compliance alerts, subscriptions, company registrations, and compliance form data. Requests are JSON over HTTPS; responses use a standard envelope with data, statusCode, and message fields.

Authentication

All endpoints require a Bearer token in the Authorization header:

Authorization: Bearer <your_api_key>
Content-Type: application/json
Accept: application/json

The Compliance API uses the same token as the Business Formation and Tax Registration APIs — if your partner agreement entitles you to multiple products, a single token authenticates against all of them. See Authorization for the request header format, host details, and error semantics.

Base URLs

EnvironmentBase URL
Productionhttps://api.corpnet.com/v1
Staginghttps://api.staging24.corpnet.com/v1

Common Path Parameters

Several endpoints share these path parameters. They appear in the route pattern for any endpoint that references them.

ParameterDescription
partnerIdPartner identifier (your Account PID issued during onboarding). Used across all endpoints. Distinct from apiUserPid — the Business Formation API uses apiUserPid in the request body for some endpoints; the Compliance API uses partnerId in the URL path. For most partners, the two identifiers are the same value, just sent in different positions.
companyIdEntity / company identifier returned by Create a Company or List Companies.
alertIdCompliance Alert identifier returned by List Compliance Alerts.
subscriptionIdSubscription Plan identifier returned by List Subscriptions.

Standard Response Codes

CodeMeaning
200Success. The request was processed and the response body contains the result.
400Bad Request — validation error, missing required parameters, or malformed JSON. Inspect message for the specific failure.
401Unauthorized — invalid, missing, or expired Bearer token.
403Forbidden — the authenticated partner does not have access to the requested resource (row-level security on a record belonging to another partner).
404Not Found — the requested resource does not exist (or you do not have visibility into it).
500Server Error — an unhandled exception or transaction rollback. Retry with backoff; if it persists, contact your CorpNet account manager.

Response Envelope

All successful responses use this top-level shape:

{
  "data": { ... },
  "statusCode": 200,
  "message": "Success"
}

For collection endpoints, data is an array. For single-resource endpoints, data is an object. For "void" actions like Cancel or Renew, data may be null or contain a confirmation payload.

Error responses follow the same envelope shape, with a non-200 statusCode and a message describing the failure:

{
  "statusCode": 400,
  "message": "No account found for the provided PID.",
  "data": null
}

Branch on statusCode (or the HTTP status code), not on message. The message text is human-readable and may change without notice; the status code is the contract.