BackgroundCheckCreate

Request body for submitting background check results

HCMHuman ResourcesRecruitingSaaSTalent Acquisition

Properties

Name	Type	Description
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	Background check status
result	string	Background check result

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BackgroundCheckCreate",
  "description": "Request body for submitting background check results",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-recruiting/refs/heads/main/json-schema/recruiting-rest-api-background-check-create-schema.json",
  "type": "object",
  "properties": {
    "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": "Background check status",
      "example": "Initiated"
    },
    "result": {
      "type": "string",
      "enum": [
        "Clear",
        "Consider",
        "Adverse Action"
      ],
      "description": "Background check result",
      "example": "Clear"
    }
  },
  "required": [
    "candidate",
    "jobApplication",
    "status"
  ]
}