Workday Recruiting · JSON Structure

Recruiting Rest Api Background Check Package Structure

A background check package defines a set of screening checks to perform on candidates during the hiring process.

Type: object Properties: 5
HCMHuman ResourcesRecruitingSaaSTalent Acquisition

BackgroundCheckPackage is a JSON Structure definition published by Workday Recruiting, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name description provider active

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-recruiting/refs/heads/main/json-structure/recruiting-rest-api-background-check-package-structure.json",
  "name": "BackgroundCheckPackage",
  "description": "A background check package defines a set of screening checks to perform on candidates during the hiring process.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Workday ID (WID) of the package",
      "example": "11111111-2222-3333-4444-555555555555"
    },
    "name": {
      "type": "string",
      "description": "Package name",
      "example": "Senior Software Engineer"
    },
    "description": {
      "type": "string",
      "description": "Description of the checks included",
      "example": "Strong technical background with 8+ years of experience in distributed systems."
    },
    "provider": {
      "type": "object",
      "description": "A reference to a related Workday resource",
      "properties": {
        "id": {
          "type": "string",
          "description": "Workday ID (WID) of the referenced resource",
          "example": "11111111-2222-3333-4444-555555555555"
        },
        "descriptor": {
          "type": "string",
          "description": "Display name of the referenced resource",
          "example": "Senior Software Engineer"
        }
      }
    },
    "active": {
      "type": "boolean",
      "description": "Whether the package is currently active",
      "example": true
    }
  }
}