Partner API v2
API
- Every route now has a
/v2twin. Most change only the prefix; see Migrating to v2 for the full mapping. - Three routes have their own
/v2contract:POST /v2/onboardreturnsorganizationUnitIdinstead ofbusinessEntityId, andGET /v2/compliance-reviewsandGET /v2/compliance-reviews/{reviewId}no longer returnbusinessEntityId. - The organization unit routes exist only under
/v2. Business entities are listed withGET /v2/organization-units?type=business_entity;/v1/business-entities*have no/v2twin. - All
/v1routes are deprecated. They keep working; see Migrating to v2 for the schedule.
- The API Reference tab shows the
/v2routes; the deprecated/v1routes moved to the Legacy API (v1) tab. - Guides and integration flows now use the
/v2routes.
Organization units and Documents v2
API
- New Organization Units routes for units of any type:
GET /v2/organization-unit-types,POST /v2/organization-units,GET /v2/organization-units,GET /v2/organization-units/{organizationUnitId}andPATCH /v2/organization-units/{organizationUnitId}. They answer404when a unit is not found;/v1/business-entities*are unchanged and still answer422. - New
/v2/documents/*routes:POST /v2/documents/submitandPOST /v2/documents/upload/starttakeorganizationUnitIdand accept an organization unit of any type. The chunk and status routes are also available under/v2and behave the same as v1. - Submitting documents now refuses an archived organization unit:
POST /v1/documents/submitandPOST /v2/documents/submitanswer422withOrganization unit not found or access denied(v1:BusinessEntity not found or access denied), and a chunked upload for an archived unit fails when its last chunk arrives. GET /v1/compliance-reviewsandGET /v1/compliance-reviews/{reviewId}now returnorganizationUnitId, with the same value asbusinessEntityId.POST /v1/documents/submitandPOST /v1/documents/upload/startare deprecated. Once the deprecation date is announced, their successful responses carryDeprecationandSunsetheaders, plus aLinkheader to the deprecation notice when one is published. Move to the/v2routes.
Docs overhaul
Documentation
- API Reference now shows curl, Node, and Python code samples for every endpoint.
- Endpoints are grouped by resource (Companies, Documents, Compliance Reviews, and more) in the reference sidebar.
- Guides now use runnable code samples instead of pseudo-code.
- Rebuilt the Error Codes page into a full catalog with causes and fixes for each status.
- New card-based landing page and a 5-minute Quickstart.
Static docs site
Documentation
- The documentation site is now served as a static Mintlify site. The API spec is refreshed from the live service on demand.