Skip to content
/
Complete an existing Repo...

Complete an existing Report

Request

Cancels all pending or suspended screenings and completes the report.

Use this endpoint to complete reports which include pending or suspended screenings. If a report is completed with pending or suspended screenings, the following events will be triggered:

  • The status for all in-progress screenings within the report will be updated to canceled.
  • A cancellation reason and the reason’s description will be added to each canceled screening.
  • Checkr will issue webhooks upon report completion.
    • If all screenings are canceled, a report.canceled webhook will be issued.
    • If at least one screening has a result before the report is completed, Checkr will issue two webhooks: first, report.updated, followed by report.complete.
Security
basic_auth
Path
idstringrequired

The Report's ID.

curl -i -X POST \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/reports/{id}/complete'

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.

Example:"539fd88c101897f7cd000001"
arrest_search_idstring

ID of the Arrest Search linked to the report.

Example:"539fd88c101897f7cd000001"
drug_alcohol_clearinghouse_idstring

ID of the Drug & Alcohol Clearinghouse Search linked to the Report.

Example:"539fd88c101897f7cd000001"
drug_screening_idstring

ID of the Drug Screening linked to the report.

Example:"539fd88c101897f7cd000001"
facis_search_idstring

ID of the FACIS Search linked to the Report.

Example:"539fd88c101897f7cd000001"
federal_criminal_search_idstring

ID of the Federal Criminal Search linked to the Report.

Example:"539fd88c101897f7cd000001"
federal_district_criminal_search_idstring

ID of the Federal District Criminal Search linked to the Report.

Example:"539fd88c101897f7cd000001"
federal_civil_search_idstring

ID of the Federal Civil Search linked to the Report.

Example:"539fd88c101897f7cd000001"
federal_district_civil_search_idstring

ID of the Federal District Civil Search linked to the Report.

Example:"539fd88c101897f7cd000001"
global_watchlist_search_idstring

ID of the Global Watchlist Search linked to the Report.

Example:"539fd88c101897f7cd000001"
social_media_screenings_idstring

ID of the Social Media Screening linked to the Report.

Example:"539fd88c101897f7cd000001"
sex_offender_search_idstring

ID of the Sex Offender Registry Search linked to the Report.

Example:"539fd88c101897f7cd000008"
national_criminal_search_idstring

ID of the National Criminal Search linked to the Report.

Example:"539fd88c101897f7cd000006"
county_criminal_search_idsArray of strings

Array of County Criminal Search IDs linked to the Report.

Example:
[
  "539fdcf335644a0ef4000003"
]
occupational_health_screening_idstring

ID of the Health Screening linked to the report.

Example:"539fdcf335644a0ef4000003"
personal_reference_verification_idsArray of strings

Array of Personal Reference Verification IDs linked to the Report.

Example:
[
  "539fdcf335644a0ef4000003"
]
professional_reference_verification_idsArray of strings

Array of Professional Reference Verification IDs linked to the Report.

Example:
[
  "539fdcf335644a0ef4000003"
]
motor_vehicle_report_idstring

ID of the Motor Vehicle Record Search linked to the Report.

Example:"539fd88c101897f7cd000007"
professional_license_verification_idsArray of strings

Array of Professional License Verification IDs linked to the Report.

Example:
[
  "5ee1b0c080c74df951ce6a59"
]
state_criminal_searchesArray of strings

Array of State Criminal Search IDs linked to the Report.

Example:
[
  "539fdcf335644a0ef4000003"
]
international_criminal_searches_v2_idsArray of strings

Array of International Criminal Search IDs linked to the Report. If no searches exist, this field is omitted.

Example:
[
  "41007c751c9a15c892c0981a0400d1"
]
international_adverse_media_search_idsArray of strings

Array of International Adverse Media Search IDs linked to the Report. If no searches exists, this field is omitted.

Example:
[
  "41007c751c9a15c892c0981a0400e2"
]
international_global_watchlist_search_idstring

ID of an International Global Watchlist Search linked to the Report. If no search exists, this field is omitted.

Example:"41007c751c9a15c892c0981a0400f3"
international_education_verification_idstring

ID of an International Education Verification linked to the Report. If no verification exists, this field is omitted.

Example:"41007c751c9a15c892c0981a040004"
international_employment_verification_idstring

ID of an International Employment Verification linked to the Report. If no verification exists, this field is omitted.

Example:"41007c751c9a15c892c0981a040015"
international_identity_document_validation_idstring

ID of an International Identity Document Validation linked to the Report. If no validation exists, this field is omitted.

Example:"41007c751c9a15c892c0981a040026"
identity_data_evaluation_idstring

ID of the identity data evaluation linked to the report. If no evaluation exists, this field is omitted.

Example:"9f82ebb23267477a606e0a9c"
identity_verification_idstring

ID of the Identity Verification linked to the Report. If no Identity Verification exists, this field is omitted. Returned by default; use ?include=identity_verification to embed the full Identity Verification object instead.

Example:"9f82ebb23267477a606e0a9c"
identity_verificationobject(IdentityVerification)

Embedded Identity Verification object. Only returned when ?include=identity_verification is passed; otherwise the Report returns identity_verification_id.

document_idsArray of strings

Array of Document IDs.

Example:
[
  "539fdcf335496a0ef4000003"
]
geo_idsArray of strings

Array of Geo IDs.

Example:
[
  "87f5bb4983eade22c55f4731"
]
program_idstring

ID of the Program linked to the Report.

Example:"00166f9ff39ec7b453adfaec"
archivedboolean

Returns true if the invitation is archived.

Example:false
Response
{
  "id": "e44aa283528e6fde7d542194",
  "object": "report",
  "uri": "/v1/reports/4722c07dd9a10c3985ae432a",
  "status": "complete",
  "result": "clear",
  "includes_canceled": false,
  "created_at": "2014-01-18T12:34:00Z",
  "completed_at": "2014-01-18T12:35:30Z",
  "revised_at": null,
  "upgraded_at": null,
  "turnaround_time": 90,
  "package": "driver_pro",
  "adjudication": "engaged",
  "assessment": "eligible",
  "source": "api",
  "segment_stamps": [
    [ … ]
  ],
  "work_locations": [
    { … }
  ],
  "estimated_completion_time": "2019-07-31T00:00:00Z",
  "candidate_story_ids": [
    "989b4c2d83dd8a81547f2dae"
  ],
  "candidate_id": "e44aa283528e6fde7d542194",
  "drug_screening": {
    "id": "539fd88c101897f7cd000001",
    "status": "clear",
    "result": "clear",
    "disposition": "negative",
    "mro_notes": "Diluted Sample",
    "analytes": [ … ],
    "events": [ … ],
    "screening_pass_expires_at": "2014-01-19T11:28:31Z",
    "appointment_id": "539fd88c101897f7cd000001"
  },
  "ssn_trace_id": "539fd88c101897f7cd000001",
  "arrest_search_id": "539fd88c101897f7cd000001",
  "drug_alcohol_clearinghouse_id": "539fd88c101897f7cd000001",
  "drug_screening_id": "539fd88c101897f7cd000001",
  "facis_search_id": "539fd88c101897f7cd000001",
  "federal_criminal_search_id": "539fd88c101897f7cd000001",
  "federal_district_criminal_search_id": "539fd88c101897f7cd000001",
  "federal_civil_search_id": "539fd88c101897f7cd000001",
  "federal_district_civil_search_id": "539fd88c101897f7cd000001",
  "global_watchlist_search_id": "539fd88c101897f7cd000001",
  "social_media_screenings_id": "539fd88c101897f7cd000001",
  "sex_offender_search_id": "539fd88c101897f7cd000008",
  "national_criminal_search_id": "539fd88c101897f7cd000006",
  "county_criminal_search_ids": [
    "539fdcf335644a0ef4000003"
  ],
  "occupational_health_screening_id": "539fdcf335644a0ef4000003",
  "personal_reference_verification_ids": [
    "539fdcf335644a0ef4000003"
  ],
  "professional_reference_verification_ids": [
    "539fdcf335644a0ef4000003"
  ],
  "motor_vehicle_report_id": "539fd88c101897f7cd000007",
  "professional_license_verification_ids": [
    "5ee1b0c080c74df951ce6a59"
  ],
  "state_criminal_searches": [
    "539fdcf335644a0ef4000003"
  ],
  "international_criminal_searches_v2_ids": [
    "41007c751c9a15c892c0981a0400d1"
  ],
  "international_adverse_media_search_ids": [
    "41007c751c9a15c892c0981a0400e2"
  ],
  "international_global_watchlist_search_id": "41007c751c9a15c892c0981a0400f3",
  "international_education_verification_id": "41007c751c9a15c892c0981a040004",
  "international_employment_verification_id": "41007c751c9a15c892c0981a040015",
  "international_identity_document_validation_id": "41007c751c9a15c892c0981a040026",
  "identity_data_evaluation_id": "9f82ebb23267477a606e0a9c",
  "identity_verification_id": "9f82ebb23267477a606e0a9c",
  "identity_verification": {
    "id": "e44aa283528e6fde7d542194",
    "object": "identity_verification",
    "uri": "/v1/identity_verifications/9f82ebb23267477a606e0a9c",
    "status": "complete",
    "result": "clear",
    "assessment": "eligible",
    "created_at": "2014-01-18T12:34:00Z",
    "completed_at": "2014-01-18T12:35:30Z",
    "turnaround_time": 0,
    "cancellation_reason": "complete_now_customer_requested",
    "cancellation_reason_description": "Customer requested Complete Now prior to screening completion",
    "evaluations": [ … ]
  },
  "document_ids": [
    "539fdcf335496a0ef4000003"
  ],
  "geo_ids": [
    "87f5bb4983eade22c55f4731"
  ],
  "program_id": "00166f9ff39ec7b453adfaec",
  "archived": false
}
© Checkr, Inc.