Retrieve an existing Package

Request

Returns an existing Package with the input ID.

Security

basic_auth

Path

idstringrequired

ID of the Package to retrieve.

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

Responses

Package details

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstringread-only

Value:"package"

uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/packages/e44aa283528e6fde7d542194"

apply_urlstring

URL at which candidates may apply for a background check with this Package.

Example:"https://apply.checkr.com/apply/customer-services-inc/532c20ea819b"

created_atstring, (date-time)

Time at which the Package was created.

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

deleted_atstring, (date-time)

Time at which the Package was deleted.

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

namestring

Human-readable name of the Package.

Example:"Criminal Pro"

slugstring

Unique key identifier of the Package.

Example:"criminal_pro"

priceinteger

Package price in USD cents.

Example:6500

screeningsArray of objects

Response

{
  "id": "e44aa283528e6fde7d542194",
  "object": "package",
  "uri": "/v1/packages/e44aa283528e6fde7d542194",
  "apply_url": "https://apply.checkr.com/apply/customer-services-inc/532c20ea819b",
  "created_at": "2014-01-18T12:34:00Z",
  "deleted_at": "2014-01-18T12:34:00Z",
  "name": "Criminal Pro",
  "slug": "criminal_pro",
  "price": 6500,
  "screenings": [
    { … }
  ]
}