The API creates the same invite as the dashboard. The candidate enters identity details on their own link.
Who it is for. A developer connecting a hiring system.
- Create a key on the API page.
- POST /api/v1/checks with the candidate name, email, location, position, pay band, and conditionalOfferMade.
- Send the returned invite URL to the candidate.
- Read status from GET /api/v1/checks/:id. The report link lasts ten minutes.
Do not send an SSN or date of birth
A body that includes ssn or dob is rejected. Those values are collected from the candidate.
The sample is on the API docs. See test keys.