POST https://api.peoplecheck.com/requestsBody parameters
string
required
Candidate’s name. Maximum length: 200 characters.
string
required
Candidate’s email address, where the request notification will be sent. Maximum length: 200 characters.
number
required
Package identification. Use an
id returned by List all packages.string
Candidate’s phone number.
string
General comment about the employee or project code.
string
Any other information about the project, candidate, or check request.
Request
Response
On success thepayload contains the created request, including the token the candidate uses to access their onboarding form and a confirmation message.
Response
The response describes the created request, not the check results. Once the candidate completes the onboarding form, track progress through Screenings or receive updates via Webhooks.

