Skip to main content
POST
Cancel a document request or mark it reviewed

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Body

application/json
request_id
string<uuid>
required

The document request (profile_interview_document_request.id, from list_document_requests).

action
enum<string>
required

What to do with the request. Options — cancel: withdraw an open request; the candidate can no longer upload to it. | reviewed: mark a completed request as reviewed; it leaves To do > Today, and marking it again changes nothing.

Available options:
cancel,
reviewed
merchant_id
string<uuid>

Optional company to act on. Admins and sub-merchant operators only; other callers always use their token's company.

Response

The request after the call.

request_id
string<uuid>
required

The document request (profile_interview_document_request.id).

action
enum<string>
required

What was done.

Available options:
cancel,
reviewed
status
enum<string>
required

The request status after the call.

Available options:
cancelled,
completed
reviewed_at
string

reviewed: when the request was (first) marked reviewed (ISO 8601).