v3

latestOpenAPI 3.1.02026-07-311255771.3 MB
AI Apply

Submit job application

Submit a job application using a submission token. The application will be queued and processed asynchronously. Returns ID to track progress and match with webhooks.

post/ai-apply/apply

Request body

submission_tokenstring required

JWT token obtained from the POST /postings/:id/inquire endpoint. Valid for 12 hours.

candidate_emailstring email required

The email address of the candidate. This is used for deduplication (preventing duplicate applications from the same candidate) and internal tracking purposes. This field is required but should not be displayed to the candidate on your application form - you should provide this from your own system.

query_paramsobject

Query parameters to be appended to the job posting URL when applying.

additional_clicksinteger

Number of times to simulate the job being opened in addition to the actual click related to the application. When set without additional_clicks_scatter_duration, uses the default 60-minute scatter window.

additional_clicks_scatter_durationinteger

Optional scatter window for additional_clicks, in minutes. Cannot be used without additional_clicks.

Response

POST /ai-apply/apply Positive response

status'success' required

Example response

{
  "data": {
    "id": "ADbmw5XSkeCSE1fAucoxEGnwZ",
    "posting_id": "JDn252PEYa4rMhKbJBjtn3ng",
    "status": "PENDING",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-03-02T23:12:32.000Z"
  }
}