Skip to main content
Three calls: create a candidate once, apply as often as you like, read the result.

1. Create a candidate

A candidate is the person you are applying for. Create them once and reuse the returned profile_id on every application.
201 Created
The profile above is the minimum accepted. Missing required fields return 422 with their dot paths and no candidate is created. Extra profile data helps answer more employer questions.

2. Apply

202 Accepted

3. Read the result

Poll the application, or receive a webhook and skip polling entirely.
200 OK
Every application ends as submitted or failed. You are charged only for submitted.

Full reference

Endpoints, statuses, failure reasons, review, webhooks and verification codes.