Skip to main content
GET
Get mandate message 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.

If-None-Match
string

Return 304 with an empty body when the current ETag matches one of the supplied validators (or *).

Path Parameters

id
string<uuid>
required

UUID of the document in this request.

mandate_id
string<uuid>
required

UUID of the parent accepted case in this request.

message_id
string<uuid>
required

UUID of the parent message in this request.

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.