Workday Recruiting Background Checks API
Submit and retrieve background check results and manage background check packages for candidate screening.
Workday Recruiting Background Checks API is one of 13 APIs that Workday Recruiting publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 56 JSON Schema definitions.
Tagged areas include Background Checks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a JSON-LD context, and 56 JSON Schemas.
This API exposes 3 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version v41.2.
Requests are made against a single base URL, https://{tenant}.workday.com/ccx/api/recruiting/v41.2.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Workday Recruiting Background Checks API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 2 scopes.
By default, every request must be authenticated.
oauth2— OAuth 2.0 authentication. Register an API client in Workday, grant recruiting scopes, and obtain access tokens.
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Submit and retrieve background check results and manage background check packages for candidate screening.
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are BackgroundCheck (7 properties), BackgroundCheckCreate (5 properties), BackgroundCheckPackage (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Workday Recruiting 12
Other APIs Workday Recruiting publishes across the network.