Every Partner API route is available under /v2. The /v1 routes keep working and are deprecated: build new integrations on /v2 and move existing ones at your own pace.

​
Scope

  • /v1 and /v2 run side by side, with the same keys. A route that needs a Partner Key or a Company Key under /v1 needs the same key under /v2.
  • All 30 /v1 operations are marked deprecated in the Legacy API (v1) reference. The flag blocks nothing: a deprecated route answers exactly as before.
  • No /v2 route is deprecated.

​
Route mapping

Error responses of the routes whose contract changes (onboard and the two review reads) are the same in v1 and v2. The v2 document routes answer Organization unit not found or access denied where v1 answers BusinessEntity not found or access denied.

​
Routes that exist only in v2

The organization unit routes exist only under /v2: GET /v2/organization-unit-types, POST /v2/organization-units, GET /v2/organization-units, GET /v2/organization-units/{organizationUnitId} and PATCH /v2/organization-units/{organizationUnitId}. See Organization Units.

​
Upload sessions in progress

A chunked upload session started with POST /v1/documents/upload/start finishes normally: upload its remaining chunks to either /v1/documents/upload/... or /v2/documents/upload/.... The session keeps the rules of the version that started it, so a session started on v1 still resolves a business_entity unit when its last chunk arrives. Start new sessions with POST /v2/documents/upload/start. See Chunked Upload.

​
Schedule

The /v1 routes have no removal date yet. Once the deprecation date is announced:
  • successful responses of /v1 routes carry a Deprecation header and a Sunset header, plus a Link header to the deprecation notice when one is published;
  • error responses, and DELETE /v1/webhooks (which answers 204 with no body), carry none of these headers;
  • the Sunset date is 180 days after the deprecation date, and no /v1 route is removed before it.

​
Support

Questions about the migration: see Support.