Checkr Candidates API
Candidate records that background checks are run against.
Checkr Candidates API is one of 14 APIs that Checkr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Candidates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 5 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against 2 base URLs: https://api.checkr.com/v1, https://api.checkr-staging.com/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Checkr Candidates API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
basicAuth— HTTP Basic auth with your secret API key as the username and an empty password. Checkr Partner integrations authenticate on behalf of customer accounts using O…
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Candidate records that background checks are run against.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Candidate (13 properties), CandidateCreate (9 properties), CandidateList (5 properties), Error (2 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 Checkr 12
Other APIs Checkr publishes across the network.