Deprecations
We keep the /v1 API backwards compatible. When we replace part of the API, the old shape keeps working and is marked deprecated — it continues to function until the version listed below, giving you time to migrate. Deprecated response fields are also flagged deprecated: true in the OpenAPI spec.
Versioning is semantic: additive, backwards‑compatible changes bump the patch (e.g. 1.0.1 → 1.0.2); a deprecated field or endpoint is only removed in the next minor (e.g. 1.1.0). The current version is 1.0.5 — see the Changelog for what each version brought. The same version covers both the Integrations API and the Partner API.
Current deprecations
| Deprecated | Since | Removed in | Use instead |
|---|---|---|---|
failed_document_indices on the document responses — finalize, prepare, and the direct multipart upload (POST /v1/clients/{id}/documents) — reports failures as positions into the request array |
1.0.1 (finalize); 1.0.2 (prepare + direct upload) |
1.1.0 |
failed_document_ids — the ids of the documents that failed, so you don't map back by position. Present on all three responses. |
Caveat while both exist:
failed_document_idscan only name a failure that got as far as creating a document row. A failure before a row exists — a total insert failure onprepare, or any failure on the direct multipart upload (whose failures are always row-creation failures) — has no id, so it appears only infailed_document_indices(andfailed_document_idsmay be empty even when there are failures). Until1.1.0, preferfailed_document_idsbut fall back tofailed_document_indices/ the response's success count on those two paths.