v1

latestOpenAPI 3.1.02026-07-1276185442.2 KB

Background Checks

Packages

Create Background Check Package

post/unified/ats/background_checks/packages

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

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

Request body

namestring nullable

Package name

descriptionstring nullable

Package description

passthroughobject nullable

Value to pass through to the provider

Example request

{
  "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"
  }
}

Response

Record created successfully.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "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"
  }
}