Skip to main content
POST
Create enforceable title document

Authorizations

Authorization
string
header
required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company
string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

Idempotency-Key
string
required

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.

Maximum string length: 255

Path Parameters

claim_id
string<uuid>
required

UUID of the parent claim in this request.

Body

A JSON body carries the document as base64 content; the file part is accepted only with multipart/form-data.

base64
string
required

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.

Required string length: 1 - 15029589
type
enum<string>
required

Title document purpose: enforceable_title is the single primary title document, required before finalization; other supplies a supporting document and may be used multiple times.

Available options:
enforceable_title,
other
file
file

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.

filename
string

Original filename shown to users. Path components and control characters are removed and the extension always follows the detected content type.

Required string length: 1 - 255

Response

Resource representation with a native UUID id.

created_at
string<date-time>
required
read-only

Time at which the document was submitted.

download_url
string<uri> | null
required
read-only

Authenticated API URL for downloading the document; null while its status is not ready.

failure_reason
enum<string> | null
required

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.

Available options:
page_limit_exceeded,
encrypted,
corrupt,
unsupported,
processing_failed
filename
string
required
read-only

Original filename shown to users.

id
string<uuid>
required
read-only

Stable identifier for this resource.

mime_type
string | null
required
read-only

Detected media type of the document.

parent
object
required

Resource that owns the document.

status
enum<string>
required

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.

Available options:
pending,
ready,
failed,
rejected
type
enum<string>
required

Business purpose of the document.

Available options:
bank_statement,
claim_statement,
correspondence,
enforceable_title,
invoice,
other,
payment_proof,
reminder,
rental_agreement
updated_at
string<date-time>
required
read-only

Time at which document processing last changed.