Authorization

Use a server-side API key with the listed grants and permitted resource access.

documents:write

Request headers

X-Api-Keyrequired: Your server-side integration credential.
Idempotency-Keyrequired: Stable key for this intended action. Reuse it for retries of the same request.
If-Matchrequired: Current ETag for the resource being changed. A stale version returns 412.
Content-Typemultipart/form-data: Let your HTTP client generate the multipart boundary.

Path parameters

idstring · required: Opaque identifier in the authorized resource scope. Nested identifiers must belong to their parent resource.
documentIdstring · required: Opaque identifier in the authorized resource scope. Nested identifiers must belong to their parent resource.

Request body

filestring · required: Document bytes. File limits are supplied by the enabled processing capability.
requirementIdstring · optional: Case document requirement ID, when uploading to a case.
documentTypestring · optional: Document type code, when uploading to a traveler vault.

Response

202Accepted

Follow the durable operation returned in Location. Processing continues independently of the connection.

Behavior to account for

Processing success and document review are separate. A warning or pending review does not automatically mean rejection. Poll the operation returned in Location.

Errors

Authentication failures return 401 or 403. Inaccessible resources return 404. Business and idempotency conflicts return 409. Rate limits return 429 with retry guidance.

Error handling guide

curl --request POST 'https://api.wincora.com/api/v1/tenant/cases/id_example/documents/documentId_example/replacement' \ --header 'X-Api-Key: YOUR_API_KEY' \ --header 'Idempotency-Key: request-example-001' \ --header 'If-Match: "resource-version"' \ --form 'file=@passport.pdf' \ --form 'requirementId=passport.identityPage'

import { readFile } from 'node:fs/promises'; const form = new FormData(); form.append('file', new Blob([await readFile('passport.pdf')]), 'passport.pdf'); form.append('requirementId', 'passport.identityPage'); const response = await fetch('https://api.wincora.com/api/v1/tenant/cases/id_example/documents/documentId_example/replacement', { method: 'POST', headers: { "X-Api-Key": process.env.WINCORA_API_KEY, "Idempotency-Key": "request-example-001", "If-Match": "\"resource-version\"" }, body: form }); if (!response.ok) throw new Error(await response.text()); const result = await response.json();

import os import requests response = requests.request( 'POST', 'https://api.wincora.com/api/v1/tenant/cases/id_example/documents/documentId_example/replacement', headers={ "X-Api-Key": os.environ["WINCORA_API_KEY"], "Idempotency-Key": "request-example-001", "If-Match": "\"resource-version\"" }, files={"file": open("passport.pdf", "rb")}, data={"requirementId": "passport.identityPage"}, timeout=30, ) response.raise_for_status() result = response.json()