Skip to content

Subscriptions

Represents a background check subscription. A background report with the Package specified will run at every interval.

Operations

Create a new Subscription

Request

Creates a new Subscription.

Notes for International Customers: Subscriptions are generally not available for packages which include international screenings since they require specific consent forms before they are run. If your candidate is located outside the US, you may not create a Subscription for them. The exceptions are Global MVR screenings, Global MVRs are the only international screening capable of handling standalone consent collection.

Security
basic_auth
Bodyapplication/jsonrequired
packagestringrequired

slug of the associated package.

candidate_idstringrequired

ID of the candidate being screened.

start_datestring, (date)required

Start date for the subscription. This is the date on which the subscription will begin, and the first time the report will be run.

interval_countinteger

The number of intervals between each recurrent background check.

interval_unitstring

Interval at which the subscription will repeat.

Enum:"day""week""month""year"
nodestring

Required for hierarchy-enabled accounts.

custom_id of the associated node.

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.

curl -i -X POST \
  -u '<username>:<password>' \
  https://docs.checkr.com/_mock/apis/openapi/subscriptions \
  -H 'Content-Type: application/json' \
  -d '{
    "package": "string",
    "candidate_id": "string",
    "start_date": "2019-08-24",
    "interval_count": 0,
    "interval_unit": "day",
    "node": "string",
    "work_locations": [
      {
        "country": "US",
        "state": "CA",
        "city": "San Francisco"
      }
    ]
  }'

Responses

Subscription was successfully created

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"
objectstringread-only
Value:"subscription"
uristring(ResourceURI)read-only

URI of the Subscription.

Example:"/v1/subscriptions/e44aa283528e6fde7d542194"
statusstring

Status of the Subscription.

Enum:"active""inactive"
Example:"active"
created_atstring, (date-time)

Time at which the Subscription was created.

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

Time at which the Subscription was canceled.

Example:null
packagestring

Package to run for the Subscription.

Example:"driver_pro"
interval_countinteger

The number of intervals between each recurrent background check.

Example:1
interval_unitstring

Interval at which the Subscription will repeat.

Enum:"day""week""month""year"
Example:"month"
start_datestring, (date)

Start date for the Subscription. This is the date on which the Subscription will begin, and the first time the report will be run.

Example:"2014-06-10"
next_occurrence_datestring, (date)

The next date on which the Subscription will be run. This date is determined based on the start_date, interval_unit, interval_count, and the last date the subscription was run.

Example:"2014-07-10"
candidate_idstring

ID of the candidate screened.

Example:"4722c07dd9a10c3985ae432a"
nodestring

Node to be used when generating a report for this Subscription.

Example:"zpy8orej4r614ize"
work_locationsArray of objects(WorkLocation)

Array of work locations to be used when generating a report for this Subscription.

Response
{
  "id": "e44aa283528e6fde7d542194",
  "object": "subscription",
  "uri": "/v1/subscriptions/e44aa283528e6fde7d542194",
  "status": "active",
  "created_at": "2014-01-18T12:34:00Z",
  "canceled_at": null,
  "package": "driver_pro",
  "interval_count": 1,
  "interval_unit": "month",
  "start_date": "2014-06-10",
  "next_occurrence_date": "2014-07-10",
  "candidate_id": "4722c07dd9a10c3985ae432a",
  "node": "zpy8orej4r614ize",
  "work_locations": [
    { … }
  ]
}
© Checkr, Inc.