SessionCreateRequest

consent_modestringrequired

How candidate consent is handled.

• explicit — the candidate frontend shows a consent gate; ZenHire captures consent.
• integrator — you have captured consent contractually; no gate is shown.

Possible values: [explicit, integrator]

candidate_refstringnullable

Your own opaque reference for the candidate (e.g. an ATS candidate id). Stored for correlation. Values longer than 256 characters are silently truncated to 256 (not rejected).

Possible values: <= 256 characters

metadata objectnullable

Optional {key:value} correlation map (same shape and limits as Speech and CV DeepMatch): string keys to string/number/boolean values, ≤ 50 keys, key ≤ 40 chars, value ≤ 500 chars, total ≤ 8 KB. Echoed back on every session response and filterable on the list.

property name*anynullable

Optional {key:value} correlation map (same shape and limits as Speech and CV DeepMatch): string keys to string/number/boolean values, ≤ 50 keys, key ≤ 40 chars, value ≤ 500 chars, total ≤ 8 KB. Echoed back on every session response and filterable on the list.

tagsstring[]nullable

Optional tags (≤ 20 distinct strings, each 1–40 chars). Echoed back on every session response and filterable on the list.

SessionCreateRequest

{
  "consent_mode": "explicit",
  "candidate_ref": "string",
  "metadata": {},
  "tags": [
    "string"
  ]
}