Skip to content

Apply a review action to a Report

Request

Applies a review action decision to a paused Report. When a Report is paused awaiting a Review Action, use this endpoint to continue or skip remaining screenings. To inspect which checkpoint is waiting, use Retrieve progressive checkpoint status.

Security
basic_auth
Path
idstringrequired

The Report's ID.

Bodyapplication/jsonrequired
decisionstringrequired

The review action decision to apply. Use continue to proceed with the remaining screenings, or skip_remaining to skip them and complete the report.

Enum:"skip_remaining""continue"
curl -i -X POST \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/reports/{id}/review_action' \
  -H 'Content-Type: application/json' \
  -d '{
    "decision": "skip_remaining"
  }'

Responses

Review action decision was successfully applied.

Bodyapplication/json
messagestring
Example:"User review decision applied"
Response
{ "message": "User review decision applied" }