Changelog - Vort Partner API

Within v1 every change is additive (see the versioning policy); breaking changes ship only as /v2, announced in advance.

Docs

Documentation site published

This documentation now has a hosted home, with an interactive API reference generated from the OpenAPI file. No API changes.

Release

v1: first release

First release of the Vort Partner API.Endpoints

Method	Path	Purpose
`POST`	`/v1/activations/redeem`	Connect a customer organization with a one-time activation code.
`POST`	`/v1/users`	Register a recruiter (an API-only identity, never a credential).
`POST`	`/v1/jobs`	Create or update a job.
`POST`	`/v1/runs`	Start a matching run, with requirement validation (at most 3 musts).
`GET`	`/v1/runs/{run_id}`	Read a run’s status, progress, notices and candidates.
`POST`	`/v1/runs/{run_id}/candidates/{candidate_id}/reveal`	Reveal a candidate’s contact details (charges credits).
`POST`	`/v1/runs/{run_id}/decisions`	Report recruiter decisions and the notices shown.

Webhooks: run_completed, run_failed and candidate_revealed, signed with HMAC-SHA256 in x-vort-signature, retried up to 8 times over about 8 hours. See Webhooks.Notices: a catalogue of stable codes with the generic-rendering rule for codes your client does not know. See Notices.Rate limits: per partner, 120 requests per minute and 20,000 per day by default.Languages: Hebrew and English (x-vort-lang).Sandbox and certification: a sandbox with certification fixtures, simulated errors and test webhooks, and a 22-item go-live checklist. See Sandbox and Certification.

​Documentation site published

​v1: first release

Documentation site published

v1: first release