Update an existing Report

Request

Updates the package or adjudication for an existing Report resource.

Use this endpoint to update reports which include the candidate's Social Security Number. To update a Report which does not include an SSN, first use the update Candidate request to add the candidate’s SSN before updating the report.

Either package or adjudication is required.

Note: This endpoint may also be used to update international reports for candidates which do not include an SSN.

Note: The Package of a Report cannot be updated if it has an Adverse Action with the status: complete or dispute. To proceed, cancel the Adverse Action or create a new Report.

Security

basic_auth

Path

idstringrequired

The Report's ID.

Bodyapplication/jsonrequired

packagestring

Slug of the Package.

Example:"driver_pro"

adjudicationstring

Value:"engaged"

Example:"engaged"

curl -i -X POST \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/reports/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "package": "driver_pro",
    "adjudication": "engaged"
  }'

Responses

Report was successfully updated

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstringread-only

Defines the object type: report.

Value:"report"

uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/reports/4722c07dd9a10c3985ae432a"

statusstring

Status of the report.

canceled if and only if all screenings, including SSN Trace, within the report were canceled. complete if at least one screening was completed. paused if the report is awaiting a Review Action decision to continue or skip.

Enum:"pending""complete""suspended""paused""dispute""canceled"

Example:"complete"

resultstring or null

Outcome of the report.

Enum:"clear""consider"

Example:"clear"

includes_canceledboolean

Returns true if the report includes a canceled screening.

Example:false

created_atstring, (date-time)

Time at which the report was created.

Example:"2014-01-18T12:34:00Z"

completed_atstring, (date-time)

Time at which the report was completed.

Example:"2014-01-18T12:35:30Z"

revised_atstring or null, (date-time)

Time at which the report was revised.

Example:null

upgraded_atstring or null, (date-time)

Time at which the report was upgraded.

Example:null

turnaround_timeinteger

Number of seconds the report took to complete, calculated from created_at to completed_at.

Example:90

packagestring

Human-readable name of the Package.

Example:"driver_pro"

adjudicationstring or null

The adjudication for the candidate. Null if no adjudication has been made.

Enum:"engaged""pre_adverse_action""post_adverse_action"

Example:"engaged"

assessmentstring or null

The assessment for the report. This field will be non-null only for Assess-enabled accounts. For accounts with Assess enabled, it will be null for reports completed before Assess was enabled, and null for a short time after report completion while the account's Assess rules are applied.

Enum:"eligible""review""escalated"

Example:"eligible"

sourcestring

The method used to create the report.
api created from the Checkr API.
continuous_check created automatically from a Continuous Check return.
form created from the Checkr Hosted Invite/Apply flow.
manual_order created from a manual order (customer enters candidate's PII) originating in the Checkr Dashboard.
recurrence created from a Subscription.
web created from Candidates > Order new Report in the Checkr Dashboard.

Enum:"api""continuous_check""form""manual_order""recurrence""web"

Example:"api"

segment_stampsArray of strings

Tier and name of the node the report was ordered with and tier|name information for all its parent nodes.

Example:

[
  [
    "unit|Anvil Charlotte",
    "company|Acme Corporation",
    "division|Anvil Sales",
    "region|Anvil South East"
  ]
]

work_locationsArray of objects(WorkLocation)

Array of work locations set while ordering this report.

estimated_completion_timestring, (date-time)

Date at which the report is predicted to be finished. Despite the date-time format, we only estimate to the date. The time is not relevant.

Example:"2019-07-31T00:00:00Z"

candidate_story_idsArray of strings

Array of Candidate Story IDs linked to the Report.

Example:

[
  "989b4c2d83dd8a81547f2dae"
]

candidate_idstring

ID of the candidate being screened.

Example:"e44aa283528e6fde7d542194"

drug_screeningobject

Embedded Drug Screening object

ssn_trace_idstring

ID of the SSN Trace linked to the Report.