Skip to main content
POST
/
unified
/
ats
/
background_checks
/
packages
Create Background Check Package
curl --request POST \
  --url https://api.stackone.com/unified/ats/background_checks/packages \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data @- <<EOF
{
  "name": "Test 1",
  "description": "Skills test to gauge a candidate's proficiency in job-specific skills",
  "tests": [
    {
      "name": "Test 1",
      "description": "Skills test to gauge a candidate's proficiency in job-specific skills"
    }
  ],
  "passthrough": {
    "other_known_names": "John Doe"
  }
}
EOF
{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

​
Prefer
string

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Example:

"heartbeat"

Body

application/json
​
name
string | null

Package name

Example:

"Test 1"

​
description
string | null

Package description

Example:

"Skills test to gauge a candidate's proficiency in job-specific skills"

​
tests
object[] | null

Package tests

​
passthrough
object

Value to pass through to the provider

Example:
{ "other_known_names": "John Doe" }

Response

Record created successfully.

​
statusCode
number
required
Example:

201

​
message
string
required
Example:

"Record created successfully."

​
timestamp
string<date-time>
required
Example:

"2021-01-01T01:01:01.000Z"

​
data
object
required