Create a new Report

Request

Creates a new Report resource.

Notes:

This resource does not support the creation of reports for packages with international screenings; use the /invitations API for these orders. However, International MVR-only packages are supported via the /reports API. If required documentation is missing for the International MVR, Checkr will raise an exception to the candidate to provide it.
Employment Verifications, Education Verifications, and Credit Checks may not be initiated using the /reports API. Please use the /invitations API to initiate the Checkr-Hosted Apply Flow when ordering background checks that include any of these screening types.
Identity Verification (IDV) may not be initiated using the /reports API. Please use the /invitations API with an IDV-enabled package to order an Identity Verification.
Creating a Report which includes an Occupational Health or Drug Check will automatically issue an email invitation to the candidate to schedule their appointment at a clinic of their choice.
consent_document_ids is required. Upload each consent PDF with Upload a Candidate Document (type consent) and pass the returned document ids.

Security

basic_auth

Bodyapplication/jsonrequired

candidate_idstringrequired

ID of the Candidate screened.

Example:"e44aa283528e6fde7d542194"

packagestringrequired

slug of the associated package. Example: driver_pro

nodestring

Required for hierarchy-enabled accounts.

custom_id of the associated node.

self_disclosuresArray of objects(SelfDisclosure)

Array of SelfDisclosures

Note: Self Disclosures may not be added, updated, or deleted after a Report has been created. The information provided in a Self Disclosure will not be included in the completed Report, and may be retrieved using GET /v1/reports/{id}?include=documents. See the Documents resource for more information.

Removing the requirement for the description, date, and location parameters greatly reduces the value of Self Disclosures. If your system mandates that these parameters be optional, work with your Checkr Customer Success Manager to disable the requirement.

work_locationsArray of objects(WorkLocation)

Required for hierarchy-enabled accounts.

Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates.

tagsArray of strings

Array of tags for the Report.

consent_document_idsArray of strings, non-emptyrequired

IDs of consent documents previously created with Upload a Candidate Document.

Each id must reference a document with type consent that belongs to the candidate_id on this request and is a PDF.

A missing, empty, or invalid value returns 400. One invalid id rejects the request, and no report is created.

Example:

[
  "b73f89e14b393979857806f9"
]

curl -i -X POST \
  -u '<username>:<password>' \
  https://docs.checkr.com/_mock/apis/openapi/reports \
  -H 'Content-Type: application/json' \
  -d '{
    "candidate_id": "e44aa283528e6fde7d542194",
    "package": "string",
    "node": "string",
    "self_disclosures": [
      {
        "description": "I made a mistake and grew from this experience.",
        "offense_level": "Misdemeanor",
        "offense_category": "Insurance Fraud",
        "sentence": "24 months probation",
        "time_served": "20 months probation",
        "date": "2019-11-01",
        "location": {
          "county": "BOULDER",
          "state": "CO",
          "country": "US"
        }
      }
    ],
    "work_locations": [
      {
        "country": "US",
        "state": "CA",
        "city": "San Francisco"
      }
    ],
    "tags": [
      "string"
    ],
    "consent_document_ids": [
      "b73f89e14b393979857806f9"
    ]
  }'

Responses

Report was successfully created

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.