> ## Documentation Index > Fetch the complete documentation index at: https://docs.paywise.de/llms.txt > Use this file to discover all available pages before exploring further. # Create claim document > Documents below one parent resource: upload, list, download, delete. ## OpenAPI ````yaml /api-docs/case-management-api/openapi.json post /v2/claims/{claim_id}/documents/ openapi: 3.0.3 info: description: >- Submit orders and manage their complete lifecycle through the current API at the `/v2/` HTTP path. title: paywise Case Management API version: current servers: - description: Production environment url: https://api.paywise.de - description: Sandbox environment url: https://api-sandbox.paywise.de security: [] tags: - description: Submit orders and manage them until acceptance. name: Orders - description: Stable claim resources and their current relationships. name: Claims - description: 'Accepted cases: state, published history and documents.' name: Mandates - description: Debtor master data reused across orders. name: Debtors - description: Payments reported by you and booked by paywise. name: Payments - description: Files attached to claims and other resources. name: Documents - description: Collective statements (Sammelabrechnungen). name: Statements - description: Per-case statements (Aktenabrechnungen). name: Single mandate statements - description: Webhook endpoints and their signing secrets. name: Webhooks - description: Delivery log and redelivery of webhook events. name: Webhook deliveries - description: Ordered feed of the events webhooks deliver. name: Events - description: Reference catalog of legal forms. name: Legal forms - description: The authenticated credential and its context. name: Info - description: Rate-limit headroom of the credential. name: Usage - description: Availability of the API. name: Health externalDocs: url: https://docs.paywise.de/api-docs/case-management-api/introduction paths: /v2/claims/{claim_id}/documents/: post: tags: - Documents summary: Create claim document description: 'Documents below one parent resource: upload, list, download, delete.' operationId: create-claim-document parameters: - description: >- Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID. in: header name: X-On-Behalf-Of-Company schema: format: uuid type: string - description: ID of the parent claim. in: path name: claim_id required: true schema: format: uuid type: string - description: >- Required client-supplied command key scoped to the selected Case company or Partner owner, method, operation and path. An exact retry replays the original response while it is retained, including after credential rotation or replacement. Current permissions are required. in: header name: Idempotency-Key required: true schema: maxLength: 255 type: string requestBody: content: application/json: examples: document-base64: value: base64: >- JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFIgPj4KZW5kb2JqCjIgMCBvYmoKPDwgL1R5cGUgL1BhZ2VzIC9LaWRzIFszIDAgUl0gL0NvdW50IDEgPj4KZW5kb2JqCjMgMCBvYmoKPDwgL1R5cGUgL1BhZ2UgL1BhcmVudCAyIDAgUiAvTWVkaWFCb3ggWzAgMCAyMDAgMTAwXSA+PgplbmRvYmoKeHJlZgowIDQKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMDAwMDAwMDExNSAwMDAwMCBuIAp0cmFpbGVyCjw8IC9TaXplIDQgL1Jvb3QgMSAwIFIgPj4Kc3RhcnR4cmVmCjE4NgolJUVPRgo= filename: invoice-2026-0042.pdf type: invoice schema: allOf: - $ref: '#/components/schemas/ClaimDocumentCreateRequest' description: >- A JSON body carries the document as base64 content; the file part is accepted only with multipart/form-data. not: required: - file multipart/form-data: examples: document-multipart: value: file: (binary PDF body) filename: invoice-2026-0042.pdf type: invoice schema: $ref: '#/components/schemas/ClaimDocumentCreateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/DocumentRead' description: '' headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '400': content: application/json: examples: validation-error: value: code: validation_error detail: The request contains invalid data. errors: - code: invalid field: claims[0].due_date message: Due date must not precede the document date. schema: $ref: '#/components/schemas/Error' description: '' headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '401': content: application/json: examples: authentication-error: value: code: not_authenticated detail: Authentication credentials were not provided. schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '404': content: application/json: examples: not-found-error: value: code: not_found detail: The requested resource was not found. schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '409': content: application/json: examples: conflict-error: value: code: conflict detail: The resource changed state and cannot accept this command. order-expired: value: code: order_expired detail: The draft order has expired and can no longer be changed. schema: $ref: '#/components/schemas/Error' description: '' headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '429': content: application/json: schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string Retry-After: description: Integer seconds to wait before retrying a throttled request. schema: minimum: 1 type: integer X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string security: - caseBearerAuth: [] - partnerBearerAuth: [] components: schemas: ClaimDocumentCreateRequest: additionalProperties: false anyOf: - not: required: - file required: - base64 title: Base64 document - not: required: - base64 required: - file title: Multipart file description: 'Generic claim attachments: slot-only types belong to their sub-resource.' properties: base64: description: >- Base64-encoded PDF, JPEG, or PNG content. Supply exactly one of base64 or multipart file. Maximum decoded file size: 10 MiB (10,485,760 bytes); maximum PDF length: 100 pages. Oversized content returns 400; too many PDF pages uses page_limit_exceeded. maxLength: 15029589 minLength: 1 type: string file: description: >- PDF, JPEG, or PNG file supplied as multipart form data. Supply exactly one of file or base64. Maximum file size: 10 MiB (10,485,760 bytes); maximum PDF length: 100 pages. Oversized content returns 400; too many PDF pages uses page_limit_exceeded. format: binary type: string filename: description: >- Original filename shown to users. Path components and control characters are removed and the extension always follows the detected content type. maxLength: 255 minLength: 1 type: string type: allOf: - $ref: '#/components/schemas/ClaimDocumentTypeEnum' description: |- Business purpose of the document. * `bank_statement` - bank_statement * `claim_statement` - claim_statement * `correspondence` - correspondence * `invoice` - invoice * `other` - other * `payment_proof` - payment_proof * `reminder` - reminder required: - type type: object DocumentRead: description: Resource representation with a native UUID `id`. properties: created_at: description: Time at which the document was submitted. format: date-time readOnly: true type: string download_url: description: >- Authenticated API URL for downloading the document; null while its status is not `ready`. format: uri nullable: true readOnly: true type: string failure_reason: allOf: - $ref: '#/components/schemas/DocumentFailureReasonEnum' description: >- Why processing failed when status is `failed`; `null` otherwise. `page_limit_exceeded`: PDF above the 100-page ceiling; `encrypted`: password-protected PDF; `corrupt`: bytes could not be parsed; `unsupported`: content type not accepted; `processing_failed`: any other processing error. nullable: true readOnly: true filename: description: Original filename shown to users. readOnly: true type: string id: description: Stable identifier for this resource. format: uuid readOnly: true type: string mime_type: description: Detected media type of the document. nullable: true readOnly: true type: string parent: allOf: - $ref: '#/components/schemas/DocumentParent' description: Resource that owns the document. readOnly: true status: allOf: - $ref: '#/components/schemas/CaseDocumentStatusEnum' description: >- Document availability: `pending` while scanning or processing is incomplete; `ready` when processing permits download; `failed` when scanning or processing failed; `rejected` when the malware check rejected the file. readOnly: true type: allOf: - $ref: '#/components/schemas/CaseDocumentTypeEnum' description: Business purpose of the document. readOnly: true updated_at: description: Time at which document processing last changed. format: date-time readOnly: true type: string required: - created_at - download_url - failure_reason - filename - id - mime_type - parent - status - type - updated_at type: object Error: properties: code: description: Machine-readable error category. type: string detail: description: Short human-readable summary of the error. type: string errors: description: Field-level validation errors, when applicable. items: $ref: '#/components/schemas/ErrorItem' type: array required: - detail - code type: object ClaimDocumentTypeEnum: description: |- * `bank_statement` - bank_statement * `claim_statement` - claim_statement * `correspondence` - correspondence * `invoice` - invoice * `other` - other * `payment_proof` - payment_proof * `reminder` - reminder enum: - bank_statement - claim_statement - correspondence - invoice - other - payment_proof - reminder type: string DocumentFailureReasonEnum: enum: - page_limit_exceeded - encrypted - corrupt - unsupported - processing_failed type: string DocumentParent: properties: id: description: Identifier of the resource that owns the document. format: uuid readOnly: true type: string type: allOf: - $ref: '#/components/schemas/DocumentParentTypeEnum' description: |- Kind of resource that owns the document. * `claim` - claim * `message` - message * `request_to_client_answer` - request_to_client_answer * `rental_agreement` - rental_agreement * `enforceable_title` - enforceable_title readOnly: true required: - id - type type: object CaseDocumentStatusEnum: enum: - pending - ready - failed - rejected type: string CaseDocumentTypeEnum: description: |- * `bank_statement` - bank_statement * `claim_statement` - claim_statement * `correspondence` - correspondence * `enforceable_title` - enforceable_title * `invoice` - invoice * `other` - other * `payment_proof` - payment_proof * `reminder` - reminder * `rental_agreement` - rental_agreement enum: - bank_statement - claim_statement - correspondence - enforceable_title - invoice - other - payment_proof - reminder - rental_agreement type: string ErrorItem: properties: code: description: Machine-readable field error code. type: string field: description: >- Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path. nullable: true type: string message: description: Human-readable explanation of the field error. type: string required: - field - code - message type: object DocumentParentTypeEnum: description: |- * `claim` - claim * `message` - message * `request_to_client_answer` - request_to_client_answer * `rental_agreement` - rental_agreement * `enforceable_title` - enforceable_title enum: - claim - message - request_to_client_answer - rental_agreement - enforceable_title type: string securitySchemes: caseBearerAuth: description: >- Company-bound Case Management API key — the standard credential for this API. scheme: bearer type: http partnerBearerAuth: description: >- Partner API key acting for one entitled company; every Case request must then also carry the X-On-Behalf-Of-Company header. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.