{ "openapi": "3.0.1", "info": { "title": "AMLService", "version": "1.0" }, "paths": { "/docs/reference": { "get": { "tags": [ "AMLService" ], "responses": { "200": { "description": "OK" } } } }, "/docs/reference/{slug}": { "get": { "tags": [ "AMLService" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/docs/reference/assets/{file}": { "get": { "tags": [ "AMLService" ], "parameters": [ { "name": "file", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/swagger-ui": { "get": { "tags": [ "AMLService" ], "responses": { "200": { "description": "OK" } } } }, "/swagger-ui/assets/{file}": { "get": { "tags": [ "AMLService" ], "parameters": [ { "name": "file", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/audit": { "get": { "tags": [ "Audit" ], "parameters": [ { "name": "action", "in": "query", "schema": { "type": "string" } }, { "name": "targetType", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "format", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuditListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuditListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuditListResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/audit/verify": { "get": { "tags": [ "Audit" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuditVerifyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuditVerifyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuditVerifyResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/screenings/batch": { "post": { "tags": [ "BatchScreening" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "Threshold": { "type": "string" }, "ExactMatch": { "type": "string" }, "AdverseMedia": { "type": "string" }, "Monitor": { "type": "string" }, "Lists": { "type": "string" }, "PepTiers": { "type": "string" }, "CoveragePreset": { "type": "string" }, "MaxDataAgeDays": { "type": "string" }, "Phonetic": { "type": "string" }, "Nicknames": { "type": "string" }, "TrigramFloor": { "type": "string" }, "CandidateLimit": { "type": "string" }, "ResultCap": { "type": "string" }, "DobYearTolerance": { "type": "string" }, "DobMismatchPenalty": { "type": "string" } } }, "encoding": { "file": { "style": "form" }, "Threshold": { "style": "form" }, "ExactMatch": { "style": "form" }, "AdverseMedia": { "style": "form" }, "Monitor": { "style": "form" }, "Lists": { "style": "form" }, "PepTiers": { "style": "form" }, "CoveragePreset": { "style": "form" }, "MaxDataAgeDays": { "style": "form" }, "Phonetic": { "style": "form" }, "Nicknames": { "style": "form" }, "TrigramFloor": { "style": "form" }, "CandidateLimit": { "style": "form" }, "ResultCap": { "style": "form" }, "DobYearTolerance": { "style": "form" }, "DobMismatchPenalty": { "style": "form" } } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchJobCreated" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchJobCreated" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchJobCreated" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "BatchScreening" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatchJobStatusResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatchJobStatusResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatchJobStatusResponse" } } } } } } } }, "/v1/screenings/batch/{jobId}": { "get": { "tags": [ "BatchScreening" ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchJobStatusResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchJobStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchJobStatusResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/screenings/batch/{jobId}/results": { "get": { "tags": [ "BatchScreening" ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "format", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchJobResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchJobResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchJobResults" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/screenings/batch/{jobId}/report": { "get": { "tags": [ "BatchScreening" ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "format", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "text/json": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/branding": { "get": { "tags": [ "Branding" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BrandingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BrandingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BrandingResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/branding": { "put": { "tags": [ "Branding" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetBrandingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetBrandingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetBrandingRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BrandingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BrandingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BrandingResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/screenings/bulk": { "post": { "tags": [ "BulkScreening" ], "parameters": [ { "name": "format", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScreeningSubject" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BulkScreeningResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkScreeningResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkScreeningResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/cases": { "get": { "tags": [ "Cases" ], "parameters": [ { "name": "decision", "in": "query", "schema": { "type": "string" } }, { "name": "reviewStatus", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "source", "in": "query", "schema": { "type": "string" } }, { "name": "riskBand", "in": "query", "schema": { "type": "string" } }, { "name": "isMatch", "in": "query", "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CaseListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CaseListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaseListResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/cases/export": { "get": { "tags": [ "Cases" ], "parameters": [ { "name": "decision", "in": "query", "schema": { "type": "string" } }, { "name": "reviewStatus", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "source", "in": "query", "schema": { "type": "string" } }, { "name": "riskBand", "in": "query", "schema": { "type": "string" } }, { "name": "isMatch", "in": "query", "schema": { "type": "boolean" } }, { "name": "format", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "text/json": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/cases/{id}": { "get": { "tags": [ "Cases" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CaseDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaseDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/cases/{id}/regulator-pack": { "get": { "tags": [ "Cases" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "format", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "text/json": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/cases/{id}/review": { "post": { "tags": [ "Cases" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewCaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReviewCaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReviewCaseRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CaseDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaseDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/cases/bulk": { "post": { "tags": [ "Cases" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCaseActionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkCaseActionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkCaseActionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BulkCaseActionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkCaseActionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkCaseActionResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/cases/{id}/notes": { "post": { "tags": [ "Cases" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddNoteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddNoteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddNoteRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CaseNoteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CaseNoteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaseNoteResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/cases/{id}/attachments": { "post": { "tags": [ "Cases" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CaseAttachmentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CaseAttachmentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaseAttachmentResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Cases" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseAttachmentResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseAttachmentResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseAttachmentResponse" } } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/cases/{id}/attachments/{attachmentId}": { "get": { "tags": [ "Cases" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/coverage/presets": { "get": { "tags": [ "Coverage" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoveragePresetDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoveragePresetDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoveragePresetDto" } } } } } } } }, "/v1/coverage": { "get": { "tags": [ "Coverage" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantCoverageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantCoverageDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantCoverageDto" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/coverage/preset": { "post": { "tags": [ "Coverage" ], "parameters": [ { "name": "key", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantCoverageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantCoverageDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantCoverageDto" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/demo/config": { "get": { "tags": [ "Demo" ], "parameters": [ { "name": "X-Forwarded-Host", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DemoConfigResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DemoConfigResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DemoConfigResponse" } } } } } } }, "/v1/eu/csv": { "get": { "tags": [ "EuSanctions" ], "responses": { "200": { "description": "OK" } } } }, "/v1/tenants/{id}/providers": { "get": { "tags": [ "ExternalProviders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalProviderResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalProviderResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalProviderResponse" } } } } } } } }, "/v1/tenants/{id}/providers/{providerType}": { "put": { "tags": [ "ExternalProviders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "providerType", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertExternalProviderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertExternalProviderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertExternalProviderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ExternalProviderResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalProviderResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalProviderResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable" } } }, "delete": { "tags": [ "ExternalProviders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "providerType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/ingest/history": { "get": { "tags": [ "Ingest" ], "parameters": [ { "name": "source", "in": "query", "schema": { "type": "string" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IngestRunResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IngestRunResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IngestRunResponse" } } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/ingest/status": { "get": { "tags": [ "IngestJob" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IngestJobStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IngestJobStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IngestJobStatus" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/ingest/refresh": { "post": { "tags": [ "IngestJob" ], "parameters": [ { "name": "source", "in": "query", "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IngestJobStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IngestJobStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IngestJobStatus" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/ingest/retag": { "post": { "tags": [ "IngestJob" ], "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IngestJobStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IngestJobStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IngestJobStatus" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/jobs": { "get": { "tags": [ "Jobs" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JobSnapshot" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JobSnapshot" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JobSnapshot" } } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/leaders": { "get": { "tags": [ "Leaders" ], "parameters": [ { "name": "country", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "role", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "yearFrom", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "yearTo", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeRelatives", "in": "query", "schema": { "type": "boolean" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "prioritize", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeadersPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeadersPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadersPage" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/leaders/export.csv": { "get": { "tags": [ "Leaders" ], "parameters": [ { "name": "country", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "role", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "yearFrom", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "yearTo", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeRelatives", "in": "query", "schema": { "type": "boolean" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "prioritize", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/leaders/export.pdf": { "get": { "tags": [ "Leaders" ], "parameters": [ { "name": "country", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "role", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "yearFrom", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "yearTo", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeRelatives", "in": "query", "schema": { "type": "boolean" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "prioritize", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/matching-profiles": { "get": { "tags": [ "MatchingProfiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MatchingProfilesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MatchingProfilesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MatchingProfilesResponse" } } } } } }, "post": { "tags": [ "MatchingProfiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchingProfileInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MatchingProfileInput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MatchingProfileInput" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MatchingProfileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MatchingProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MatchingProfileDto" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/matching-profiles/{profileId}": { "put": { "tags": [ "MatchingProfiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchingProfileInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MatchingProfileInput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MatchingProfileInput" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MatchingProfileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MatchingProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MatchingProfileDto" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "MatchingProfiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/matching-profiles/{profileId}/activate": { "post": { "tags": [ "MatchingProfiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MatchingProfileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MatchingProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MatchingProfileDto" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/matching-profiles/reset": { "post": { "tags": [ "MatchingProfiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetToPresetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetToPresetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetToPresetRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MatchingProfileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MatchingProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MatchingProfileDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/me": { "get": { "tags": [ "Me" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MeResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/monitoring/subjects": { "get": { "tags": [ "Monitoring" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoredSubjectResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoredSubjectResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoredSubjectResponse" } } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/monitoring/subjects/{id}": { "delete": { "tags": [ "Monitoring" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/monitoring/config": { "get": { "tags": [ "MonitoringConfig" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantMonitoringConfig" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantMonitoringConfig" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantMonitoringConfig" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "MonitoringConfig" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMonitoringConfigRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetMonitoringConfigRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetMonitoringConfigRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantMonitoringConfig" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantMonitoringConfig" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantMonitoringConfig" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/ofac/search": { "post": { "tags": [ "Ofac" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SanctionsSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SanctionsSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SanctionsSearchRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/v1/ofac/screen": { "post": { "tags": [ "Ofac" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SanctionsScreeningRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SanctionsScreeningRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SanctionsScreeningRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/v1/opensanctions/batch": { "post": { "tags": [ "OpenSanctions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenSanctionsMatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenSanctionsMatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenSanctionsMatchRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OpenSanctionsMatchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenSanctionsMatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenSanctionsMatchResponse" } } } } } } }, "/v1/pep-coverage": { "get": { "tags": [ "PepCoverage" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoverageMatrixResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoverageMatrixResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoverageMatrixResponse" } } } } } } }, "/v1/pep-coverage/refresh": { "post": { "tags": [ "PepCoverage" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoverageMatrixResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoverageMatrixResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoverageMatrixResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/peps": { "get": { "tags": [ "Peps" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "country", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PepsPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PepsPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PepsPage" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/peps/export.csv": { "get": { "tags": [ "Peps" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "country", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/peps/export.pdf": { "get": { "tags": [ "Peps" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "country", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/privacy/subjects/{userReference}/export": { "get": { "tags": [ "Privacy" ], "parameters": [ { "name": "userReference", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SubjectExportResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubjectExportResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubjectExportResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/privacy/subjects/{userReference}/erase": { "post": { "tags": [ "Privacy" ], "parameters": [ { "name": "userReference", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EraseSubjectResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EraseSubjectResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EraseSubjectResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/privacy/subjects/{userReference}/restrict": { "post": { "tags": [ "Privacy" ], "parameters": [ { "name": "userReference", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SubjectFlagResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubjectFlagResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubjectFlagResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/privacy/subjects/{userReference}/object": { "post": { "tags": [ "Privacy" ], "parameters": [ { "name": "userReference", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SubjectFlagResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubjectFlagResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubjectFlagResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/privacy/subjects/{userReference}/rectify": { "post": { "tags": [ "Privacy" ], "parameters": [ { "name": "userReference", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RectifySubjectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RectifySubjectRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RectifySubjectRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RectifySubjectResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RectifySubjectResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RectifySubjectResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/privacy/consent": { "post": { "tags": [ "Privacy" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordConsentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordConsentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordConsentRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConsentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConsentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConsentResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/privacy/subjects/{userReference}/consent": { "get": { "tags": [ "Privacy" ], "parameters": [ { "name": "userReference", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConsentHistoryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConsentHistoryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConsentHistoryResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/privacy/subjects/{userReference}/consent/withdraw": { "post": { "tags": [ "Privacy" ], "parameters": [ { "name": "userReference", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WithdrawConsentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WithdrawConsentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WithdrawConsentResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/quota": { "put": { "tags": [ "Quota" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetQuotaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetQuotaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetQuotaRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/rate-limit": { "put": { "tags": [ "Quota" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetRateLimitRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetRateLimitRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetRateLimitRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/demo-ip-rate-limit": { "put": { "tags": [ "Quota" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDemoIpRateLimitRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetDemoIpRateLimitRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetDemoIpRateLimitRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/batch-config": { "put": { "tags": [ "Quota" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetBatchConfigRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetBatchConfigRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetBatchConfigRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/credits": { "put": { "tags": [ "Quota" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCreditsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetCreditsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetCreditsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/sanctions-policy": { "put": { "tags": [ "Quota" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetSanctionsPolicyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetSanctionsPolicyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetSanctionsPolicyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SanctionsPolicyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SanctionsPolicyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SanctionsPolicyResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/usage": { "get": { "tags": [ "Quota" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuotaUsageResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/register": { "post": { "tags": [ "Register" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RegisterResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegisterResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/risk-profile": { "get": { "tags": [ "RiskProfiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskProfileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskProfileDto" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "RiskProfiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskProfileDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RiskProfileDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskProfileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskProfileDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/risk-profile/coverage-presets": { "get": { "tags": [ "RiskProfiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoveragePresetDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoveragePresetDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoveragePresetDto" } } } } } } } }, "/v1/tenants/{id}/risk-profile/coverage-preset": { "post": { "tags": [ "RiskProfiles" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "key", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskProfileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskProfileDto" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/screenings/check": { "post": { "tags": [ "Screening" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScreeningCheckRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScreeningCheckRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ScreeningCheckRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScreeningResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScreeningResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScreeningResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/screenings/{id}/rescreen": { "post": { "tags": [ "Screening" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScreeningResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScreeningResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScreeningResponse" } } } }, "402": { "description": "Payment Required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/screenings/{id}": { "get": { "tags": [ "Screening" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScreeningResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScreeningResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScreeningResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/screenings/{id}/report": { "get": { "tags": [ "Screening" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "format", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "text/json": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/lists/version": { "get": { "tags": [ "Screening" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ListVersionResponse" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ListVersionResponse" } } }, "text/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ListVersionResponse" } } } } } } } }, "/v1/screenings/search": { "get": { "tags": [ "ScreeningSearch" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "decision", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScreeningSearchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScreeningSearchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScreeningSearchResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/admin/stats": { "get": { "tags": [ "Stats" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StatsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants": { "post": { "tags": [ "Tenants" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardTenantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OnboardTenantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OnboardTenantRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OnboardTenantResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OnboardTenantResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OnboardTenantResponse" } } } } } }, "get": { "tags": [ "Tenants" ], "responses": { "200": { "description": "OK" } } } }, "/v1/tenants/{id}": { "get": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/tenants/{id}/status": { "put": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetTenantStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetTenantStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetTenantStatusRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/v1/tenants/{id}/monitoring": { "get": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMonitoringConfigRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetMonitoringConfigRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetMonitoringConfigRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/v1/tenants/{id}/webhooks": { "post": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRequest" } } } }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/tenants/{id}/webhooks/{webhookId}": { "delete": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/tenants/{id}/api-keys": { "post": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "label", "in": "query", "schema": { "type": "string" } }, { "name": "live", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IssuedApiKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IssuedApiKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssuedApiKey" } } } } } } }, "/v1/tenants/{id}/api-keys/{keyId}": { "delete": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "keyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/threshold/events": { "post": { "tags": [ "Threshold" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordTurnoverEventRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordTurnoverEventRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordTurnoverEventRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TurnoverEventResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurnoverEventResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurnoverEventResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/threshold/subjects/{subjectReference}": { "get": { "tags": [ "Threshold" ], "parameters": [ { "name": "subjectReference", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThresholdSubjectResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThresholdSubjectResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThresholdSubjectResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/tenants/{id}/threshold-config": { "put": { "tags": [ "ThresholdConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetThresholdConfigRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetThresholdConfigRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetThresholdConfigRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThresholdConfigResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThresholdConfigResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThresholdConfigResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "ThresholdConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThresholdConfigResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThresholdConfigResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThresholdConfigResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/ui/config": { "get": { "tags": [ "Ui" ], "parameters": [ { "name": "X-Forwarded-Host", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UiConfigResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UiConfigResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UiConfigResponse" } } } } } } }, "/v1/admin/watchlists/ingest": { "post": { "tags": [ "WatchlistsAdmin" ], "parameters": [ { "name": "source", "in": "query", "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IngestJobStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IngestJobStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IngestJobStatus" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/webhooks": { "post": { "tags": [ "Webhooks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreatedWebhookDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatedWebhookDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatedWebhookDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Webhooks" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpointDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpointDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpointDto" } } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/webhooks/{id}": { "delete": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/webhooks/deliveries": { "get": { "tags": [ "Webhooks" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDeliveryDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDeliveryDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDeliveryDto" } } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "components": { "schemas": { "AddNoteRequest": { "type": "object", "properties": { "body": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Address": { "type": "object", "properties": { "address1": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "stateOrProvince": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddressDto": { "type": "object", "properties": { "address1": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "stateOrProvince": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AuditEntryResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "actor": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "targetType": { "type": "string", "nullable": true }, "targetId": { "type": "string", "nullable": true }, "metadata": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AuditListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AuditEntryResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AuditVerifyResponse": { "type": "object", "properties": { "entries": { "type": "integer", "format": "int32" }, "valid": { "type": "boolean" }, "firstBrokenId": { "type": "string", "format": "uuid", "nullable": true }, "skippedLegacy": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BatchJobCreated": { "type": "object", "properties": { "jobId": { "type": "string", "format": "uuid" }, "totalRows": { "type": "integer", "format": "int32" }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BatchJobResults": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/BatchJobStatusResponse" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/BatchJobRowResult" }, "nullable": true } }, "additionalProperties": false }, "BatchJobRowResult": { "type": "object", "properties": { "rowIndex": { "type": "integer", "format": "int32" }, "fullName": { "type": "string", "nullable": true }, "userReference": { "type": "string", "nullable": true }, "screeningId": { "type": "string", "format": "uuid", "nullable": true }, "isMatch": { "type": "boolean" }, "decision": { "type": "string", "nullable": true }, "riskScore": { "type": "integer", "format": "int32" }, "matchCount": { "type": "integer", "format": "int32" }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BatchJobStatusResponse": { "type": "object", "properties": { "jobId": { "type": "string", "format": "uuid" }, "fileName": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "totalRows": { "type": "integer", "format": "int32" }, "processedRows": { "type": "integer", "format": "int32" }, "matchedRows": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BrandingResponse": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "logoUrl": { "type": "string", "nullable": true }, "accentColor": { "type": "string", "nullable": true }, "theme": { "$ref": "#/components/schemas/BrandingTheme" } }, "additionalProperties": false }, "BrandingTheme": { "type": "object", "properties": { "accentColor": { "type": "string", "nullable": true }, "secondaryColor": { "type": "string", "nullable": true }, "surfaceColor": { "type": "string", "nullable": true }, "textColor": { "type": "string", "nullable": true }, "fontFamily": { "type": "string", "nullable": true }, "cornerRadius": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BulkCaseActionItemResult": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BulkCaseActionRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "action": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BulkCaseActionResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/BulkCaseActionItemResult" }, "nullable": true } }, "additionalProperties": false }, "BulkScreeningResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScreeningRowResult" }, "nullable": true }, "summary": { "$ref": "#/components/schemas/BulkScreeningSummary" } }, "additionalProperties": false }, "BulkScreeningRowResult": { "type": "object", "properties": { "rowIndex": { "type": "integer", "format": "int32" }, "fullName": { "type": "string", "nullable": true }, "userReference": { "type": "string", "nullable": true }, "screeningId": { "type": "string", "format": "uuid", "nullable": true }, "isMatch": { "type": "boolean" }, "decision": { "type": "string", "nullable": true }, "riskScore": { "type": "integer", "format": "int32" }, "matchCount": { "type": "integer", "format": "int32" }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BulkScreeningSubject": { "type": "object", "properties": { "userReference": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "aliases": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "BulkScreeningSummary": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "screened": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CaseAttachmentResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fileName": { "type": "string", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "sizeBytes": { "type": "integer", "format": "int64" }, "uploadedBy": { "type": "string", "nullable": true }, "uploadedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CaseDetailResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fullName": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "userReference": { "type": "string", "nullable": true }, "isMatch": { "type": "boolean" }, "aggregateScore": { "type": "number", "format": "double" }, "classification": { "type": "string", "nullable": true }, "decision": { "type": "string", "nullable": true }, "riskScore": { "type": "integer", "format": "int32" }, "riskBand": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "reviewStatus": { "type": "string", "nullable": true }, "reviewedBy": { "type": "string", "nullable": true }, "reviewedAt": { "type": "string", "format": "date-time", "nullable": true }, "reviewReason": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/CaseMatchedEntity" }, "nullable": true }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/CaseNoteResponse" }, "nullable": true }, "factors": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorResponse" }, "nullable": true } }, "additionalProperties": false }, "CaseDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "cryptoId": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/AddressDto" }, "identification": { "type": "array", "items": { "$ref": "#/components/schemas/IdentificationDto" }, "nullable": true } }, "additionalProperties": false }, "CaseListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CaseSummary" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CaseMatchedEntity": { "type": "object", "properties": { "sourceList": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "matchedName": { "type": "string", "nullable": true }, "score": { "type": "number", "format": "double" }, "classification": { "type": "string", "nullable": true }, "rejectionTag": { "type": "string", "nullable": true }, "pepTier": { "type": "string", "nullable": true }, "pepJurisdiction": { "type": "string", "nullable": true }, "dataAsOf": { "type": "string", "format": "date-time", "nullable": true }, "leadershipSummary": { "type": "string", "nullable": true }, "leadershipSourceUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CaseNoteResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "author": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "isSystem": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CaseSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fullName": { "type": "string", "nullable": true }, "isMatch": { "type": "boolean" }, "decision": { "type": "string", "nullable": true }, "riskScore": { "type": "integer", "format": "int32" }, "riskBand": { "type": "string", "nullable": true }, "reviewStatus": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ConsentHistoryResponse": { "type": "object", "properties": { "subjectReference": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConsentResponse" }, "nullable": true } }, "additionalProperties": false }, "ConsentResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "subjectReference": { "type": "string", "nullable": true }, "consentVersion": { "type": "string", "nullable": true }, "consentText": { "type": "string", "nullable": true }, "consentTextSha256": { "type": "string", "nullable": true }, "channel": { "type": "string", "nullable": true }, "capturedAt": { "type": "string", "format": "date-time" }, "withdrawn": { "type": "boolean" }, "withdrawnAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CountByLabel": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CoverageMatrixResponse": { "type": "object", "properties": { "generatedAt": { "type": "string", "format": "date-time" }, "hasGaps": { "type": "boolean" }, "totalReachableButMissed": { "type": "integer", "format": "int32" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/CoverageRowResponse" }, "nullable": true } }, "additionalProperties": false }, "CoveragePresetDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "summary": { "type": "string", "nullable": true }, "enabledLists": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pepTiers": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CoverageRowResponse": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "fatfLabel": { "type": "string", "nullable": true }, "tier": { "type": "string", "nullable": true }, "availableCurrentHolders": { "type": "integer", "format": "int32" }, "ingestedHolders": { "type": "integer", "format": "int32" }, "coveragePct": { "type": "number", "format": "double" }, "reachableButMissed": { "type": "integer", "format": "int32" }, "hasGap": { "type": "boolean" } }, "additionalProperties": false }, "CreateWebhookRequest": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "events": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CreatedWebhookDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "nullable": true }, "events": { "type": "array", "items": { "type": "string" }, "nullable": true }, "signingSecret": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DemoConfigResponse": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "publicApiKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EraseSubjectResponse": { "type": "object", "properties": { "subjectReference": { "type": "string", "nullable": true }, "recordsAnonymized": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ExportAuditEntry": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "actor": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "targetType": { "type": "string", "nullable": true }, "targetId": { "type": "string", "nullable": true }, "metadata": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ExportCase": { "type": "object", "properties": { "screeningId": { "type": "string", "format": "uuid" }, "reviewStatus": { "type": "string", "nullable": true }, "reviewedBy": { "type": "string", "nullable": true }, "reviewedAt": { "type": "string", "format": "date-time", "nullable": true }, "reviewReason": { "type": "string", "nullable": true }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/ExportNote" }, "nullable": true } }, "additionalProperties": false }, "ExportConsent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "consentVersion": { "type": "string", "nullable": true }, "consentText": { "type": "string", "nullable": true }, "consentTextSha256": { "type": "string", "nullable": true }, "channel": { "type": "string", "nullable": true }, "capturedAt": { "type": "string", "format": "date-time" }, "withdrawn": { "type": "boolean" }, "withdrawnAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ExportFlags": { "type": "object", "properties": { "restricted": { "type": "boolean" }, "objected": { "type": "boolean" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ExportMatch": { "type": "object", "properties": { "sourceList": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "matchedName": { "type": "string", "nullable": true }, "score": { "type": "number", "format": "double" }, "classification": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExportMonitoring": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fullName": { "type": "string", "nullable": true }, "active": { "type": "boolean" }, "lastDecision": { "type": "string", "nullable": true }, "lastScreenedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ExportNote": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "author": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "isSystem": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ExportRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "requestedBy": { "type": "string", "nullable": true }, "requestedAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ExportScreening": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fullName": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "aliases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isMatch": { "type": "boolean" }, "aggregateScore": { "type": "number", "format": "double" }, "classification": { "type": "string", "nullable": true }, "decision": { "type": "string", "nullable": true }, "riskScore": { "type": "integer", "format": "int32" }, "riskBand": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "matchedEntities": { "type": "array", "items": { "$ref": "#/components/schemas/ExportMatch" }, "nullable": true } }, "additionalProperties": false }, "ExternalProviderResponse": { "required": [ "createdAt", "enabled", "hasApiKey", "includeDatasets", "keywords", "providerType", "topics", "updatedAt" ], "type": "object", "properties": { "providerType": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "hasApiKey": { "type": "boolean" }, "collection": { "type": "string", "nullable": true }, "algorithm": { "type": "string", "nullable": true }, "threshold": { "type": "number", "format": "double", "nullable": true }, "includeDatasets": { "type": "array", "items": { "type": "string" }, "nullable": true }, "topics": { "type": "array", "items": { "type": "string" }, "nullable": true }, "baseUrl": { "type": "string", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "nullable": true }, "maxRecords": { "type": "integer", "format": "int32", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Identification": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "idNumber": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IdentificationDto": { "type": "object", "properties": { "idNumber": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IngestJobStatus": { "type": "object", "properties": { "running": { "type": "boolean" }, "source": { "type": "string", "nullable": true }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "elapsedSeconds": { "type": "number", "format": "double", "nullable": true }, "lastCompletedAt": { "type": "string", "format": "date-time", "nullable": true }, "lastSuccess": { "type": "boolean", "nullable": true }, "lastError": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IngestRunResponse": { "type": "object", "properties": { "sourceList": { "type": "string", "nullable": true }, "startedAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time" }, "durationSeconds": { "type": "number", "format": "double" }, "success": { "type": "boolean" }, "entityCount": { "type": "integer", "format": "int32" }, "version": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IssuedApiKey": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "apiKey": { "type": "string", "nullable": true }, "prefix": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JobRunState": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "JobSnapshot": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "state": { "$ref": "#/components/schemas/JobRunState" }, "phase": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "processed": { "type": "integer", "format": "int64", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true }, "runningTotalEntities": { "type": "integer", "format": "int64", "nullable": true }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "success": { "type": "boolean", "nullable": true }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LeaderRowDto": { "type": "object", "properties": { "person": { "type": "string", "nullable": true }, "qid": { "type": "string", "nullable": true }, "dob": { "type": "string", "nullable": true }, "personUrl": { "type": "string", "nullable": true }, "countryIso": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "countryQid": { "type": "string", "nullable": true }, "office": { "type": "string", "nullable": true }, "officeQid": { "type": "string", "nullable": true }, "officeUrl": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "termStart": { "type": "string", "nullable": true }, "termEnd": { "type": "string", "nullable": true }, "isCurrent": { "type": "boolean" }, "pepClass": { "type": "string", "nullable": true }, "pepClassLabel": { "type": "string", "nullable": true }, "relativeOf": { "$ref": "#/components/schemas/RelativeOfDto" } }, "additionalProperties": false }, "LeadersPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LeaderRowDto" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ListVersionResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "publishedAt": { "type": "string", "format": "date-time", "nullable": true }, "downloadedAt": { "type": "string", "format": "date-time" }, "entityCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MatchQuery": { "type": "object", "properties": { "schema": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": false }, "MatchResponseItem": { "type": "object", "properties": { "query": { "$ref": "#/components/schemas/MatchQuery" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MatchResult" }, "nullable": true } }, "additionalProperties": false }, "MatchResult": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "schema": { "type": "string", "nullable": true }, "score": { "type": "number", "format": "double" }, "caption": { "type": "string", "nullable": true }, "datasets": { "type": "array", "items": { "type": "string" }, "nullable": true }, "properties": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "programId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MatchedEntityResponse": { "type": "object", "properties": { "sourceList": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "matchedName": { "type": "string", "nullable": true }, "score": { "type": "number", "format": "double" }, "classification": { "type": "string", "nullable": true }, "rejectionTag": { "type": "string", "nullable": true }, "discardReason": { "type": "string", "nullable": true }, "pepTier": { "type": "string", "nullable": true }, "adverseMediaCategory": { "type": "string", "nullable": true }, "criminalCategory": { "type": "string", "nullable": true }, "pepJurisdiction": { "type": "string", "nullable": true }, "dataAsOf": { "type": "string", "format": "date-time", "nullable": true }, "leadershipSummary": { "type": "string", "nullable": true }, "leadershipSourceUrl": { "type": "string", "nullable": true }, "headline": { "type": "string", "nullable": true }, "publisher": { "type": "string", "nullable": true }, "publishedAt": { "type": "string", "format": "date-time", "nullable": true }, "matchedPerson": { "type": "string", "nullable": true }, "exculpatoryOutcome": { "type": "string", "nullable": true }, "articleTone": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MatchingPresetDto": { "required": [ "candidateLimit", "defaultFuzzyThreshold", "displayName", "dobMismatchPenalty", "dobYearTolerance", "exactMatch", "isDefault", "key", "nicknamesEnabled", "phoneticEnabled", "resultCap", "summary", "trigramFloor" ], "type": "object", "properties": { "defaultFuzzyThreshold": { "type": "number", "format": "double" }, "phoneticEnabled": { "type": "boolean" }, "exactMatch": { "type": "boolean" }, "nicknamesEnabled": { "type": "boolean" }, "trigramFloor": { "type": "number", "format": "double" }, "candidateLimit": { "type": "integer", "format": "int32" }, "resultCap": { "type": "integer", "format": "int32" }, "dobYearTolerance": { "type": "integer", "format": "int32" }, "dobMismatchPenalty": { "type": "number", "format": "double" }, "enabledLists": { "type": "array", "items": { "type": "string" }, "nullable": true }, "key": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "summary": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "MatchingProfileDto": { "required": [ "candidateLimit", "createdAt", "defaultFuzzyThreshold", "dobMismatchPenalty", "dobYearTolerance", "exactMatch", "id", "isActive", "name", "nicknamesEnabled", "phoneticEnabled", "resultCap", "trigramFloor", "updatedAt" ], "type": "object", "properties": { "defaultFuzzyThreshold": { "type": "number", "format": "double" }, "phoneticEnabled": { "type": "boolean" }, "exactMatch": { "type": "boolean" }, "nicknamesEnabled": { "type": "boolean" }, "trigramFloor": { "type": "number", "format": "double" }, "candidateLimit": { "type": "integer", "format": "int32" }, "resultCap": { "type": "integer", "format": "int32" }, "dobYearTolerance": { "type": "integer", "format": "int32" }, "dobMismatchPenalty": { "type": "number", "format": "double" }, "enabledLists": { "type": "array", "items": { "type": "string" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "basePresetKey": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "MatchingProfileInput": { "required": [ "candidateLimit", "defaultFuzzyThreshold", "dobMismatchPenalty", "dobYearTolerance", "exactMatch", "nicknamesEnabled", "phoneticEnabled", "resultCap", "trigramFloor" ], "type": "object", "properties": { "defaultFuzzyThreshold": { "type": "number", "format": "double" }, "phoneticEnabled": { "type": "boolean" }, "exactMatch": { "type": "boolean" }, "nicknamesEnabled": { "type": "boolean" }, "trigramFloor": { "type": "number", "format": "double" }, "candidateLimit": { "type": "integer", "format": "int32" }, "resultCap": { "type": "integer", "format": "int32" }, "dobYearTolerance": { "type": "integer", "format": "int32" }, "dobMismatchPenalty": { "type": "number", "format": "double" }, "enabledLists": { "type": "array", "items": { "type": "string" }, "nullable": true }, "name": { "type": "string", "nullable": true }, "basePresetKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MatchingProfilesResponse": { "required": [ "presets", "profiles" ], "type": "object", "properties": { "profiles": { "type": "array", "items": { "$ref": "#/components/schemas/MatchingProfileDto" }, "nullable": true }, "presets": { "type": "array", "items": { "$ref": "#/components/schemas/MatchingPresetDto" }, "nullable": true } }, "additionalProperties": false }, "MeResponse": { "type": "object", "properties": { "tenantId": { "type": "string", "format": "uuid" }, "tenantName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "creditBalance": { "type": "integer", "format": "int32" }, "creditCostPerScreen": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MonitoredSubjectResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "userReference": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "requestedLists": { "type": "array", "items": { "type": "string" }, "nullable": true }, "lastIsMatch": { "type": "boolean" }, "lastRiskScore": { "type": "integer", "format": "int32" }, "lastDecision": { "type": "string", "nullable": true }, "lastScreenedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "OnboardTenantRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "contactEmail": { "type": "string", "nullable": true }, "plan": { "type": "string", "nullable": true }, "enabledLists": { "type": "array", "items": { "type": "string" }, "nullable": true }, "defaultFuzzyThreshold": { "type": "number", "format": "double", "nullable": true }, "webhookUrl": { "type": "string", "nullable": true }, "monthlyScreeningQuota": { "type": "integer", "format": "int32", "nullable": true }, "rateLimitPerMinute": { "type": "integer", "format": "int32", "nullable": true }, "liveApiKey": { "type": "boolean" }, "brandDisplayName": { "type": "string", "nullable": true }, "brandLogoUrl": { "type": "string", "nullable": true }, "brandAccentColor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OnboardTenantResponse": { "type": "object", "properties": { "tenantId": { "type": "string", "format": "uuid" }, "apiKey": { "type": "string", "nullable": true }, "webhookSigningSecret": { "type": "string", "nullable": true }, "enabledLists": { "type": "array", "items": { "type": "string" }, "nullable": true }, "plan": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OpenSanctionsMatchRequest": { "type": "object", "properties": { "config": { "type": "object", "additionalProperties": { }, "nullable": true }, "weights": { "type": "object", "additionalProperties": { "type": "number", "format": "double", "nullable": true }, "nullable": true }, "queries": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MatchQuery" }, "nullable": true }, "limit": { "type": "integer", "format": "int32", "nullable": true }, "threshold": { "type": "number", "format": "double", "nullable": true }, "algorithm": { "type": "string", "nullable": true }, "include_dataset": { "type": "array", "items": { "type": "string" }, "nullable": true }, "exclude_schema": { "type": "array", "items": { "type": "string" }, "nullable": true }, "exclude_dataset": { "type": "array", "items": { "type": "string" }, "nullable": true }, "topics": { "type": "array", "items": { "type": "string" }, "nullable": true }, "exclude_entity_ids": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OpenSanctionsMatchResponse": { "type": "object", "properties": { "responses": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MatchResponseItem" }, "nullable": true } }, "additionalProperties": false }, "PepRowDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "primaryName": { "type": "string", "nullable": true }, "nationalities": { "type": "array", "items": { "type": "string" }, "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pepTier": { "type": "string", "nullable": true }, "jurisdiction": { "type": "string", "nullable": true }, "sourceList": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "sourceUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PepsPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PepRowDto" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "QuotaUsageResponse": { "type": "object", "properties": { "monthlyScreeningQuota": { "type": "integer", "format": "int32", "nullable": true }, "used": { "type": "integer", "format": "int32" }, "remaining": { "type": "integer", "format": "int32", "nullable": true }, "period": { "type": "string", "nullable": true }, "rateLimitPerMinute": { "type": "integer", "format": "int32", "nullable": true }, "requestsLastMinute": { "type": "integer", "format": "int32" }, "creditBalance": { "type": "integer", "format": "int32" }, "creditCostPerScreen": { "type": "integer", "format": "int32" }, "demoIpRateLimitPerHour": { "type": "integer", "format": "int32", "nullable": true }, "maxBatchRows": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "RecordConsentRequest": { "type": "object", "properties": { "subjectReference": { "type": "string", "nullable": true }, "consentVersion": { "type": "string", "nullable": true }, "consentText": { "type": "string", "nullable": true }, "channel": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RecordTurnoverEventRequest": { "type": "object", "properties": { "subjectReference": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "occurredAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "RectifySubjectRequest": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "aliases": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RectifySubjectResponse": { "type": "object", "properties": { "subjectReference": { "type": "string", "nullable": true }, "updatedScreeningId": { "type": "string", "format": "uuid", "nullable": true }, "updated": { "type": "boolean" } }, "additionalProperties": false }, "RegisterRequest": { "type": "object", "properties": { "companyName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegisterResponse": { "type": "object", "properties": { "tenantId": { "type": "string", "format": "uuid" }, "tenantName": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "apiKey": { "type": "string", "nullable": true }, "monthlyFreeScreenings": { "type": "integer", "format": "int32" }, "plan": { "type": "string", "nullable": true }, "loginVerificationSent": { "type": "boolean" }, "keyClass": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RelativeOfDto": { "type": "object", "properties": { "qid": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResetToPresetRequest": { "type": "object", "properties": { "presetKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReviewCaseRequest": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RiskFactorResponse": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "sourceList": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "contribution": { "type": "number", "format": "double" } }, "additionalProperties": false }, "RiskProfileDto": { "required": [ "allowLowBandPass", "candidateLimit", "categoryWeights", "countryWeights", "criminalWeight", "defaultFuzzyThreshold", "dobMismatchPenalty", "dobYearTolerance", "enabledLists", "escalateHighBandToFail", "exactMatch", "highThreshold", "lowThreshold", "mediumThreshold", "nicknamesEnabled", "phoneticEnabled", "resultCap", "trigramFloor" ], "type": "object", "properties": { "countryWeights": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "nullable": true }, "categoryWeights": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "nullable": true }, "criminalWeight": { "type": "number", "format": "double" }, "lowThreshold": { "type": "integer", "format": "int32" }, "mediumThreshold": { "type": "integer", "format": "int32" }, "highThreshold": { "type": "integer", "format": "int32" }, "enabledLists": { "type": "array", "items": { "type": "string" }, "nullable": true }, "defaultFuzzyThreshold": { "type": "number", "format": "double" }, "homeJurisdiction": { "type": "string", "nullable": true }, "coveragePreset": { "type": "string", "nullable": true }, "pepTierFilter": { "type": "array", "items": { "type": "string" }, "nullable": true }, "maxDataAgeDays": { "type": "integer", "format": "int32", "nullable": true }, "escalateHighBandToFail": { "type": "boolean" }, "allowLowBandPass": { "type": "boolean" }, "phoneticEnabled": { "type": "boolean" }, "exactMatch": { "type": "boolean" }, "nicknamesEnabled": { "type": "boolean" }, "trigramFloor": { "type": "number", "format": "double" }, "candidateLimit": { "type": "integer", "format": "int32" }, "resultCap": { "type": "integer", "format": "int32" }, "dobYearTolerance": { "type": "integer", "format": "int32" }, "dobMismatchPenalty": { "type": "number", "format": "double" } }, "additionalProperties": false }, "SanctionCase": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "dob": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "citizenship": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "cryptoId": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Address" }, "identification": { "type": "array", "items": { "$ref": "#/components/schemas/Identification" }, "nullable": true } }, "additionalProperties": false }, "SanctionsPolicyResponse": { "type": "object", "properties": { "unconfirmedSanctionsDecision": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SanctionsScreeningRequest": { "type": "object", "properties": { "apiKey": { "type": "string", "nullable": true }, "minScore": { "type": "integer", "format": "int32" }, "sources": { "type": "array", "items": { "type": "string" }, "nullable": true }, "types": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cases": { "type": "array", "items": { "$ref": "#/components/schemas/SanctionCase" }, "nullable": true } }, "additionalProperties": false }, "SanctionsSearchRequest": { "type": "object", "properties": { "apiKey": { "type": "string", "nullable": true }, "sources": { "type": "array", "items": { "type": "string" }, "nullable": true }, "types": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cases": { "type": "array", "items": { "$ref": "#/components/schemas/CaseDto" }, "nullable": true } }, "additionalProperties": false }, "ScreeningCheckRequest": { "type": "object", "properties": { "userReference": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "aliases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "lists": { "type": "array", "items": { "type": "string" }, "nullable": true }, "threshold": { "type": "number", "format": "double", "nullable": true }, "exactMatch": { "type": "boolean", "nullable": true }, "phonetic": { "type": "boolean", "nullable": true }, "nicknames": { "type": "boolean", "nullable": true }, "trigramFloor": { "type": "number", "format": "double", "nullable": true }, "candidateLimit": { "type": "integer", "format": "int32", "nullable": true }, "resultCap": { "type": "integer", "format": "int32", "nullable": true }, "dobYearTolerance": { "type": "integer", "format": "int32", "nullable": true }, "dobMismatchPenalty": { "type": "number", "format": "double", "nullable": true }, "monitor": { "type": "boolean", "nullable": true }, "pepTiers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "coveragePreset": { "type": "string", "nullable": true }, "maxDataAgeDays": { "type": "integer", "format": "int32", "nullable": true }, "adverseMedia": { "type": "boolean", "nullable": true }, "includeDiagnostics": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ScreeningDiagnostics": { "type": "object", "properties": { "totalMs": { "type": "integer", "format": "int64" }, "candidateMatchMs": { "type": "integer", "format": "int64" }, "classifyMs": { "type": "integer", "format": "int64" }, "riskMs": { "type": "integer", "format": "int64" }, "persistMs": { "type": "integer", "format": "int64" }, "providersRun": { "type": "integer", "format": "int32" }, "matchCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ScreeningResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "isMatch": { "type": "boolean" }, "score": { "type": "number", "format": "double" }, "classification": { "type": "string", "nullable": true }, "decision": { "type": "string", "nullable": true }, "riskScore": { "type": "integer", "format": "int32" }, "riskBand": { "type": "string", "nullable": true }, "matchedEntities": { "type": "array", "items": { "$ref": "#/components/schemas/MatchedEntityResponse" }, "nullable": true }, "factors": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorResponse" }, "nullable": true }, "listsVersion": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "diagnostics": { "$ref": "#/components/schemas/ScreeningDiagnostics" }, "adverseMediaStatus": { "type": "string", "nullable": true }, "adverseMediaAttribution": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScreeningSearchItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fullName": { "type": "string", "nullable": true }, "decision": { "type": "string", "nullable": true }, "riskScore": { "type": "integer", "format": "int32" }, "isMatch": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "rank": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ScreeningSearchResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ScreeningSearchItem" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ScreeningStats": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "matches": { "type": "integer", "format": "int32" }, "last24Hours": { "type": "integer", "format": "int32" }, "last7Days": { "type": "integer", "format": "int32" }, "byDecision": { "type": "array", "items": { "$ref": "#/components/schemas/CountByLabel" }, "nullable": true }, "byRiskBand": { "type": "array", "items": { "$ref": "#/components/schemas/CountByLabel" }, "nullable": true } }, "additionalProperties": false }, "SetBatchConfigRequest": { "type": "object", "properties": { "maxBatchRows": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SetBrandingRequest": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "logoUrl": { "type": "string", "nullable": true }, "accentColor": { "type": "string", "nullable": true }, "secondaryColor": { "type": "string", "nullable": true }, "surfaceColor": { "type": "string", "nullable": true }, "textColor": { "type": "string", "nullable": true }, "fontFamily": { "type": "string", "nullable": true }, "cornerRadius": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetCreditsRequest": { "type": "object", "properties": { "creditBalance": { "type": "integer", "format": "int32", "nullable": true }, "creditCostPerScreen": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SetDemoIpRateLimitRequest": { "type": "object", "properties": { "requestsPerHour": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SetMonitoringConfigRequest": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "cadenceDaysOverride": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SetQuotaRequest": { "type": "object", "properties": { "monthlyScreeningQuota": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SetRateLimitRequest": { "type": "object", "properties": { "requestsPerMinute": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SetSanctionsPolicyRequest": { "type": "object", "properties": { "unconfirmedSanctionsDecision": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetTenantStatusRequest": { "type": "object", "properties": { "active": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "SetThresholdConfigRequest": { "type": "object", "properties": { "threshold": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string", "nullable": true }, "windowDays": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "StatsResponse": { "type": "object", "properties": { "generatedAt": { "type": "string", "format": "date-time" }, "watchlists": { "$ref": "#/components/schemas/WatchlistStats" }, "screenings": { "$ref": "#/components/schemas/ScreeningStats" }, "tenants": { "$ref": "#/components/schemas/TenantStats" }, "recentRefreshes": { "type": "array", "items": { "$ref": "#/components/schemas/WatchlistRefreshDto" }, "nullable": true } }, "additionalProperties": false }, "SubjectExportResponse": { "type": "object", "properties": { "subjectReference": { "type": "string", "nullable": true }, "tenantId": { "type": "string", "format": "uuid" }, "generatedAt": { "type": "string", "format": "date-time" }, "screenings": { "type": "array", "items": { "$ref": "#/components/schemas/ExportScreening" }, "nullable": true }, "cases": { "type": "array", "items": { "$ref": "#/components/schemas/ExportCase" }, "nullable": true }, "consents": { "type": "array", "items": { "$ref": "#/components/schemas/ExportConsent" }, "nullable": true }, "monitoring": { "type": "array", "items": { "$ref": "#/components/schemas/ExportMonitoring" }, "nullable": true }, "flags": { "$ref": "#/components/schemas/ExportFlags" }, "auditTrail": { "type": "array", "items": { "$ref": "#/components/schemas/ExportAuditEntry" }, "nullable": true }, "requests": { "type": "array", "items": { "$ref": "#/components/schemas/ExportRequest" }, "nullable": true } }, "additionalProperties": false }, "SubjectFlagResponse": { "type": "object", "properties": { "subjectReference": { "type": "string", "nullable": true }, "restricted": { "type": "boolean" }, "objected": { "type": "boolean" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TenantCoverageDto": { "type": "object", "properties": { "preset": { "type": "string", "nullable": true }, "enabledLists": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pepTiers": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TenantMonitoringConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "cadenceDaysOverride": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "TenantStats": { "type": "object", "properties": { "totalTenants": { "type": "integer", "format": "int32" }, "activeApiKeys": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ThresholdConfigResponse": { "type": "object", "properties": { "threshold": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string", "nullable": true }, "windowDays": { "type": "integer", "format": "int32", "nullable": true }, "enabled": { "type": "boolean" } }, "additionalProperties": false }, "ThresholdSubjectResponse": { "type": "object", "properties": { "subjectReference": { "type": "string", "nullable": true }, "accumulatedTurnover": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "windowDays": { "type": "integer", "format": "int32" }, "threshold": { "type": "number", "format": "double", "nullable": true }, "breached": { "type": "boolean" }, "status": { "type": "string", "nullable": true }, "lastTriggeredAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TurnoverEventResult": { "type": "object", "properties": { "subjectReference": { "type": "string", "nullable": true }, "windowTurnover": { "type": "number", "format": "double" }, "threshold": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string", "nullable": true }, "windowDays": { "type": "integer", "format": "int32" }, "breached": { "type": "boolean" }, "rescreenId": { "type": "string", "format": "uuid", "nullable": true }, "rescreenSkippedReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UiConfigResponse": { "type": "object", "properties": { "marketingUrl": { "type": "string", "nullable": true }, "logoutUrl": { "type": "string", "nullable": true }, "selfHosted": { "type": "boolean" }, "oidcAuthority": { "type": "string", "nullable": true }, "oidcClientId": { "type": "string", "nullable": true }, "editionLabel": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpsertExternalProviderRequest": { "required": [ "enabled" ], "type": "object", "properties": { "enabled": { "type": "boolean" }, "apiKey": { "type": "string", "nullable": true }, "collection": { "type": "string", "nullable": true }, "algorithm": { "type": "string", "nullable": true }, "threshold": { "type": "number", "format": "double", "nullable": true }, "includeDatasets": { "type": "array", "items": { "type": "string" }, "nullable": true }, "topics": { "type": "array", "items": { "type": "string" }, "nullable": true }, "baseUrl": { "type": "string", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "nullable": true }, "maxRecords": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "WatchlistRefreshDto": { "type": "object", "properties": { "sourceList": { "type": "string", "nullable": true }, "finishedAt": { "type": "string", "format": "date-time" }, "success": { "type": "boolean" }, "entityCount": { "type": "integer", "format": "int32" }, "version": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WatchlistSourceStat": { "type": "object", "properties": { "sourceList": { "type": "string", "nullable": true }, "entityCount": { "type": "integer", "format": "int32" }, "version": { "type": "string", "nullable": true }, "downloadedAt": { "type": "string", "format": "date-time", "nullable": true }, "versionEntityCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "WatchlistStats": { "type": "object", "properties": { "sources": { "type": "array", "items": { "$ref": "#/components/schemas/WatchlistSourceStat" }, "nullable": true }, "totalEntities": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "WebhookDeliveryDto": { "type": "object", "properties": { "eventType": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "success": { "type": "boolean" }, "statusCode": { "type": "integer", "format": "int32", "nullable": true }, "error": { "type": "string", "nullable": true }, "attemptedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "WebhookEndpointDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "nullable": true }, "events": { "type": "array", "items": { "type": "string" }, "nullable": true }, "active": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "WithdrawConsentResponse": { "type": "object", "properties": { "subjectReference": { "type": "string", "nullable": true }, "recordsWithdrawn": { "type": "integer", "format": "int32" } }, "additionalProperties": false } } } }