Skip to main content

JobsError

Standard error envelope returned by every Jobs endpoint on a non-2xx response — the same canonical envelope as the other modules, with requestId always present.

error objectrequired
codestringrequired

Stable machine-readable error code.

  • INVALID_INPUT — one or more fields failed validation; per-field detail in error.details.fields (config-contract failures use the inner path, e.g. requirements.workExperience.relevant_industries).
  • UNAUTHENTICATED — no API key / session, or it could not be resolved (401).
  • MISSING_PERMISSION — the client holds neither cvdeepmatch nor cvdeepsearch (403).
  • CLIENT_NOT_ELIGIBLE — the client is not active (403).
  • POSITION_ID_CONFLICT — an active job with this position_id already exists for your client (409).
  • NOT_FOUND — no active job with that id for your client; also returned for archived jobs and cross-tenant ids (404).
  • INTERNAL_ERROR — uncategorised server error (500).

Possible values: [INVALID_INPUT, UNAUTHENTICATED, MISSING_PERMISSION, CLIENT_NOT_ELIGIBLE, POSITION_ID_CONFLICT, NOT_FOUND, INTERNAL_ERROR]

messagestringrequired

Human-readable message.

requestIdstringrequired

Correlation id for this error response (quote it to support).

timestampdate-timerequired
details object

Code-specific structured detail. For INVALID_INPUT this is { "fields": { "<field>": ["<message>", …] } }. May be absent.

property name*any

Code-specific structured detail. For INVALID_INPUT this is { "fields": { "<field>": ["<message>", …] } }. May be absent.

JobsError
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "string",
    "requestId": "string",
    "timestamp": "2024-07-29T15:51:28.071Z",
    "details": {}
  }
}