Skip to main content
GET
Get mandate request to client

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 client request in this request.

mandate_id
string<uuid>
required

UUID of the parent accepted case in this request.

Response

Published clarification request with its optional answer.

allowed_answer_types
enum<string>
required

Answer format accepted by the answer endpoint. Choice formats use text: yes or text: no; yes-no-dontknow also permits dontknow. Formats ending in freetext-on-no require additional_comment for no; yes-with-date-no-freetext-on-no requires booking_date for yes. freetext requires text; fileupload accepts text, documents, or both.

Available options:
fileupload,
freetext,
yes-no,
yes-no-dontknow,
yes-no-freetext-on-no,
yes-with-date-no-freetext-on-no
answer
object | null
required

Submitted answer, or null while unanswered.

answered
boolean
required
read-only

Whether an answer has already been submitted.

answered_at
string<date-time> | null
required
read-only

Time at which the answer was submitted, when answered.

created_at
string<date-time>
required
read-only

Time at which the request was created.

description
string | null
required
read-only

Question or explanation describing what paywise needs.

href
string<uri>
required
read-only

API URL of this client request.

id
string<uuid>
required
read-only

Stable identifier of this client request.

mandate
object
required

Accepted case for which paywise needs information.

question_attachments
object[]
required
read-only

Files paywise attached to the question.

title
string
required
read-only

Short subject of the requested information.

updated_at
string<date-time>
required
read-only

Time at which the request was last updated.