Set job title eligibility verdict

Sets the job title eligibility verdict the employment's next contract-details submission
will act on, so the flow that verdict drives can be tested without an AI call deciding
the outcome.

Use it to reach an outcome on demand: a submission that passes, one rejected as not
eligible, one that must carry employer_acknowledges_risk, or one that places the
employment into a human review and emits the review webhooks.

The response is the same as the real job title eligibility check
endpoint
. Send the
returned check_id back as additional_job_title_eligibility_check_slug when submitting
contract details, exactly as you would in production.

role_description must be the one the submission will carry, since the submission
verifies that the recorded verdict still describes what was sent.

A not_assessed verdict means the check does not apply to this employment at all — not a
draft, a PEO employment, a country or hiring model that does not screen job titles, or an
integration that bypasses the check — and nothing was recorded.

The stage of the check that screens the job title alone is shared by every company in the
environment, so setting a verdict takes over that job title's screen for all of them.

This endpoint is only available in Sandbox, otherwise it will respond with a 404.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Employment ID

Body Params

Job title eligibility verdict params

string

The job title to record the verdict against. Defaults to the employment's current one.

string
required

The role description the submission will carry. A submission carrying a different one is rejected, because the recorded verdict no longer describes what was sent.

string
enum
required

The verdict the employment's next contract-details submission should act on.

Allowed:
Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json