BackgroundCheck

Background check results for a candidate, provided by an external screening provider.

HCMHuman ResourcesRecruitingSaaSTalent Acquisition

Properties

Name	Type	Description
id	string	Workday ID (WID) of the background check
candidate	object	A reference to a related Workday resource
jobApplication	object	A reference to a related Workday resource
package	object	A reference to a related Workday resource
status	string	Current status of the background check
result	string	Background check result
completedOn	string	Timestamp when the check was completed

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BackgroundCheck",
  "description": "Background check results for a candidate, provided by an external screening provider.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-recruiting/refs/heads/main/json-schema/recruiting-rest-api-background-check-schema.json",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Workday ID (WID) of the background check",
      "example": "11111111-2222-3333-4444-555555555555"
    },
    "candidate": {
      "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"
        }
      }
    },
    "jobApplication": {
      "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"
        }
      }
    },
    "package": {
      "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"
        }
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "Initiated",
        "In Progress",
        "Completed",
        "Canceled"
      ],
      "description": "Current status of the background check",
      "example": "Initiated"
    },
    "result": {
      "type": "string",
      "enum": [
        "Clear",
        "Consider",
        "Adverse Action"
      ],
      "description": "Background check result",
      "example": "Clear"
    },
    "completedOn": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the check was completed",
      "example": "2026-05-03T14:30:00Z"
    }
  }
}