{ "openapi": "3.1.0", "info": { "title": "Hawk Ai API", "version": "2", "description": "Identity verification and AML screening. Generated from the server route table at build time: it cannot describe an endpoint that does not exist. Errors are JSON with an `error` field written for a person, and a `field` when one input is at fault.", "contact": { "email": "hello@ai-sns.io", "url": "https://hawkai.ai-sns.io/en/docs" } }, "servers": [ { "url": "https://hawkai.ai-sns.io" } ], "tags": [ { "name": "Authentication" }, { "name": "Applicants" }, { "name": "Client configuration" }, { "name": "Platform" }, { "name": "Alerts and cases" }, { "name": "Screening" }, { "name": "Documents and export" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "A session token or an API key. API keys are scoped; the scope needed is on each operation." } } }, "security": [ { "bearerAuth": [] } ], "paths": { "/v2/auth/login": { "post": { "tags": [ "Authentication" ], "description": "Public — no authentication.", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/mfa": { "post": { "tags": [ "Authentication" ], "description": "Public — no authentication.", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/logout": { "post": { "tags": [ "Authentication" ], "description": "Any signed-in user.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/me": { "get": { "tags": [ "Authentication" ], "description": "Platform administrators only.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/mfa/setup": { "post": { "tags": [ "Authentication" ], "description": "Any signed-in user.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/mfa/confirm": { "post": { "tags": [ "Authentication" ], "description": "Any signed-in user.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/mfa/backup-codes": { "post": { "tags": [ "Authentication" ], "description": "Any signed-in user.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } }, "get": { "tags": [ "Authentication" ], "description": "Any signed-in user.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/sso/status": { "get": { "tags": [ "Authentication" ], "description": "Public — no authentication.", "security": [], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/sso/start": { "get": { "tags": [ "Authentication" ], "summary": "Starts the ceremony: a 302 to the provider with state, nonce and PKCE.", "description": "Public — no authentication.", "security": [], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/sso/callback": { "get": { "tags": [ "Authentication" ], "description": "Public — no authentication.", "security": [], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/passkey/register/begin": { "post": { "tags": [ "Authentication" ], "description": "Any signed-in user.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/passkey/register/finish": { "post": { "tags": [ "Authentication" ], "description": "Any signed-in user.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/passkeys": { "get": { "tags": [ "Authentication" ], "description": "Any signed-in user.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/passkeys/{id}": { "delete": { "tags": [ "Authentication" ], "description": "Any signed-in user.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/passkey/begin": { "post": { "tags": [ "Authentication" ], "description": "Public — no authentication.", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/passkey/finish": { "post": { "tags": [ "Authentication" ], "description": "Public — no authentication.", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/password": { "post": { "tags": [ "Authentication" ], "description": "Any signed-in user.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/applicants": { "get": { "tags": [ "Applicants" ], "description": "Requires the `applicants:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } }, "post": { "tags": [ "Applicants" ], "description": "Requires the `applicants:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/applicants/{id}": { "get": { "tags": [ "Applicants" ], "description": "Requires the `applicants:read` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } }, "patch": { "tags": [ "Applicants" ], "description": "Requires the `applicants:write` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/applicants/{id}/recheck": { "post": { "tags": [ "Applicants" ], "description": "Requires the `applicants:write` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/applicants/{id}/decision": { "post": { "tags": [ "Applicants" ], "description": "Requires the `applicants:decide` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/usage": { "get": { "tags": [ "Client configuration" ], "description": "Requires the `config:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/invoices": { "get": { "tags": [ "Client configuration" ], "description": "Requires the `config:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/invoices/{period}": { "get": { "tags": [ "Client configuration" ], "description": "Requires the `config:read` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "period", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/plans": { "get": { "tags": [ "Platform" ], "description": "Public — no authentication.", "security": [], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/plan": { "post": { "tags": [ "Client configuration" ], "description": "Requires the `config:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/applicants/bulk": { "post": { "tags": [ "Applicants" ], "description": "Requires the `applicants:decide` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/alerts/bulk": { "post": { "tags": [ "Alerts and cases" ], "description": "Requires the `alerts:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/applicants/{id}/endorse": { "post": { "tags": [ "Applicants" ], "description": "Requires the `applicants:decide` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/applicants/import": { "post": { "tags": [ "Applicants" ], "description": "Requires the `applicants:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/suppressions": { "get": { "tags": [ "Client configuration" ], "description": "Requires the `alerts:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } }, "post": { "tags": [ "Client configuration" ], "description": "Requires the `alerts:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/suppressions/{id}": { "delete": { "tags": [ "Client configuration" ], "description": "Requires the `alerts:write` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/filters": { "get": { "tags": [ "Client configuration" ], "description": "Requires the `applicants:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } }, "post": { "tags": [ "Client configuration" ], "description": "Requires the `applicants:read` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/filters/{id}": { "delete": { "tags": [ "Client configuration" ], "description": "Requires the `applicants:read` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/pause": { "post": { "tags": [ "Client configuration" ], "description": "Requires the `config:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/resume": { "post": { "tags": [ "Client configuration" ], "description": "Requires the `config:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/rules/simulate": { "post": { "tags": [ "Client configuration" ], "description": "Requires the `config:read` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/applicants/{id}/screening/{index}": { "post": { "tags": [ "Applicants" ], "description": "Requires the `applicants:decide` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/applicants/{id}/notes": { "post": { "tags": [ "Applicants" ], "description": "Requires the `applicants:read` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/alerts": { "get": { "tags": [ "Alerts and cases" ], "description": "Requires the `alerts:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/alerts/{id}": { "patch": { "tags": [ "Alerts and cases" ], "description": "Requires the `alerts:write` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/cases": { "get": { "tags": [ "Alerts and cases" ], "description": "Requires the `cases:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } }, "post": { "tags": [ "Alerts and cases" ], "description": "Requires the `cases:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/cases/{id}/notes": { "post": { "tags": [ "Alerts and cases" ], "description": "Requires the `cases:write` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/signup": { "post": { "tags": [ "Authentication" ], "description": "Public — no authentication.", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenants": { "post": { "tags": [ "Client configuration" ], "summary": "A platform admin taking on a client directly, rather than the client signing itself up. Same provisioning, plus an owner invitation if one is named.", "description": "Platform administrators only.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/onboarding": { "get": { "tags": [ "Client configuration" ], "description": "Requires the `config:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/invite/{token}": { "get": { "tags": [ "Authentication" ], "summary": "What the acceptance page needs to render, and nothing more: enough to show who the invitation is for, never enough to enumerate accounts.", "description": "Public — no authentication.", "security": [], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/invite/accept": { "post": { "tags": [ "Authentication" ], "description": "Public — no authentication.", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/team/{userId}/invite": { "post": { "tags": [ "Client configuration" ], "summary": "Re-issue a link for somebody already on the team: a resend, or a reset for a colleague who is locked out. Requires team:write, so it is an act by someone who already administers that client.", "description": "Requires the `team:write` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/auth/forgot": { "post": { "tags": [ "Authentication" ], "description": "Public — no authentication.", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/screening/lists": { "get": { "tags": [ "Screening" ], "description": "Requires the `config:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/screening/refresh": { "post": { "tags": [ "Screening" ], "description": "Platform administrators only.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/screening/rescreen": { "post": { "tags": [ "Screening" ], "description": "Requires the `config:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/screening/internal": { "get": { "tags": [ "Screening" ], "description": "Requires the `config:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } }, "put": { "tags": [ "Screening" ], "description": "Requires the `config:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } }, "delete": { "tags": [ "Screening" ], "description": "Requires the `config:write` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant": { "get": { "tags": [ "Client configuration" ], "description": "Requires the `config:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/settings": { "put": { "tags": [ "Client configuration" ], "description": "Requires the `config:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/team": { "get": { "tags": [ "Client configuration" ], "description": "Requires the `config:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } }, "post": { "tags": [ "Client configuration" ], "description": "Requires the `team:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/keys": { "get": { "tags": [ "Client configuration" ], "description": "Requires the `keys:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } }, "post": { "tags": [ "Client configuration" ], "description": "Requires the `keys:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/keys/{id}": { "delete": { "tags": [ "Client configuration" ], "description": "Requires the `keys:write` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/webhooks": { "get": { "tags": [ "Client configuration" ], "description": "Requires the `webhooks:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } }, "post": { "tags": [ "Client configuration" ], "description": "Requires the `webhooks:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/webhooks/{id}/ping": { "post": { "tags": [ "Client configuration" ], "description": "Requires the `webhooks:write` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/rules": { "get": { "tags": [ "Client configuration" ], "description": "Requires the `config:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/flows": { "get": { "tags": [ "Client configuration" ], "description": "Requires the `config:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/analytics/breakdown": { "get": { "tags": [ "Platform" ], "description": "Requires the `applicants:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/analytics/series": { "get": { "tags": [ "Platform" ], "description": "Requires the `applicants:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/audit": { "get": { "tags": [ "Platform" ], "description": "Requires the `audit:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/export/audit.csv": { "get": { "tags": [ "Documents and export" ], "description": "Requires the `audit:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "CSV, UTF-8 with a byte-order mark so a spreadsheet opens it correctly", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/tenant/branding/logo": { "post": { "tags": [ "Client configuration" ], "description": "Requires the `config:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } }, "delete": { "tags": [ "Client configuration" ], "description": "Requires the `config:write` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/applicants/compare": { "get": { "tags": [ "Applicants" ], "description": "Requires the `applicants:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/features": { "get": { "tags": [ "Platform" ], "description": "Public — no authentication.", "security": [], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/capabilities": { "get": { "tags": [ "Platform" ], "description": "Public — no authentication.", "security": [], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/readiness": { "get": { "tags": [ "Platform" ], "description": "Any signed-in user.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/verification-sessions": { "post": { "tags": [ "Applicants" ], "description": "Requires the `applicants:write` scope.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/verify/session/{token}": { "get": { "tags": [ "Applicants" ], "summary": "Public: what the hosted flow needs to render itself before the applicant has typed anything. Authenticated by the session token, like the submission — without this the flow cannot know whose name to show, and a client's applicants would read another company's name on their consent screen.", "description": "Public — no authentication.", "security": [], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/verify/resume": { "post": { "tags": [ "Applicants" ], "description": "Public — no authentication.", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/verify/resume/{token}": { "get": { "tags": [ "Applicants" ], "description": "Public — no authentication.", "security": [], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/verify/document": { "post": { "tags": [ "Applicants" ], "description": "Public — no authentication.", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/verify/submit": { "post": { "tags": [ "Applicants" ], "description": "Public — no authentication.", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/export/applicants.csv": { "get": { "tags": [ "Documents and export" ], "description": "Requires the `export` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "CSV, UTF-8 with a byte-order mark so a spreadsheet opens it correctly", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/export/warehouse.ndjson": { "get": { "tags": [ "Documents and export" ], "description": "Requires the `export` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/applicants/{id}/documents": { "post": { "tags": [ "Applicants" ], "description": "Requires the `applicants:write` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/documents/{id}": { "get": { "tags": [ "Documents and export" ], "description": "Requires the `applicants:read` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/retention/preview": { "get": { "tags": [ "Documents and export" ], "description": "Requires the `config:read` scope.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/applicants/{id}/erase": { "post": { "tags": [ "Applicants" ], "description": "Requires the `config:write` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } }, "/v2/applicants/{id}/data": { "get": { "tags": [ "Applicants" ], "description": "Requires the `applicants:read` scope.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was not valid. The body names the field." }, "401": { "description": "No session or key was presented." }, "403": { "description": "The principal exists but may not do this." }, "404": { "description": "No such object for this client." }, "429": { "description": "Rate limited. `retry_after` is in seconds." }, "500": { "description": "Unexpected. The body carries a `reference` that appears in our log." } } } } } }