Skip to content

International Motor Vehicle Report

Checks the validity of a driver license and where available, may include a detailed history of the candidate’s driving violations or license conditions. Canada only at this time. Refer to International Screenings for more details.

Retrieve an existing International Motor Vehicle Report

Request

Returns an existing International Motor Vehicle Report with the input ID.

Security
basic_auth
Path
idstringrequired

ID of the International Motor Vehicle Report to retrieve.

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

Responses

International Motor Vehicle Report details

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

Example:"41007cffefb435cf7d701f75d8b86d"
objectstring
Value:"international_motor_vehicle_report"
uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/international_motor_vehicle_reports/41007cffefb435cf7d701f75d8b86d"
statusstring

Status of the screening.

Enum:"pending""complete""canceled""suspended"
Example:"complete"
resultstring or null

Result of the screening.

Enum:"clear""consider"
Example:"clear"
created_atstring, (date-time)

Time at which the screening was created.

Example:"2014-01-18T12:34:00Z"
completed_atstring, (date-time)

Time at which the screening was completed.

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

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

Example:90
cancellation_reasonstring

See cancellation reasons section for possible values.

Example:"complete_now_customer_requested"
cancellation_reason_descriptionstring

See cancellation reasons section for possible values.

Example:"Customer requested Complete Now prior to screening completion"
countrystring

ISO 3166-2 country code of the jurisdiction where the search was run

Example:"CA"
pdf_urlstring

URL to PDF document containing screening result details

Example:"https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf"
license_reportsArray of objects(LicenseReport)

Array of LicenseReport objects

Response
{ "id": "41007cffefb435cf7d701f75d8b86d", "object": "international_motor_vehicle_report", "uri": "/v1/international_motor_vehicle_reports/41007cffefb435cf7d701f75d8b86d", "status": "complete", "result": "clear", "created_at": "2014-01-18T12:34:00Z", "completed_at": "2014-01-18T12:35:30Z", "turnaround_time": 90, "cancellation_reason": "complete_now_customer_requested", "cancellation_reason_description": "Customer requested Complete Now prior to screening completion", "country": "CA", "pdf_url": "https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf", "license_reports": [ { … } ] }