Workday Recruiting · JSON Structure

Recruiting Rest Api Background Check Create Structure

Request body for submitting background check results

Type: object Properties: 5 Required: 3
HCMHuman ResourcesRecruitingSaaSTalent Acquisition

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

Properties

candidate jobApplication package status result

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-create-structure.json",
  "name": "BackgroundCheckCreate",
  "description": "Request body for submitting background check results",
  "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"
  ]
}