--- updatedAt: 2026-04-13T12:21:26.000Z agentTools: projectIndex: https://docs.company.info/llms.txt --- # /follow-lists/{follow_list_id}/subscriptions/persons/{subscription_id}/alerts/auto-reviews # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "Compliance Monitoring API", "description": "Compliance Monitoring API", "version": "2.0.0" }, "servers": [ { "url": "https://api.company.info/compliance/monitor/v2" } ], "security": [ { "ApiKeyAuth": [] } ], "paths": { "/follow-lists": { "get": { "tags": [ "Follow Lists" ], "parameters": [ { "name": "page", "in": "query", "style": "deepObject", "description": "`size`defines the number of records to return in each page. default value: 10, maximum value: 20.
`cursor`specifies the next page cursor.", "schema": { "$ref": "#/components/schemas/Page" } } ], "responses": { "200": { "description": "OK", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ListOfFollowList" } } }, "headers": { "X-Correlation-Id": { "schema": { "type": "string", "format": "uuid", "description": "Unique request identifier" } }, "X-Ratelimit-Limit": { "schema": { "type": "integer", "description": "The number of request available in a rate limit window" } }, "X-Ratelimit-Remaining": { "schema": { "type": "integer", "description": "The number of requests left for the rate limit window" } }, "X-Ratelimit-Reset": { "schema": { "type": "integer", "description": "The Unix timestamp at which the current rate limit window resets" } } } }, "400": { "description": "Bad Request", "content": { "application/vnd.api+json": { "schema": { "title": "JSON:API Error Response", "type": "object", "required": [ "errors" ], "properties": { "errors": { "title": "An array of Error objects", "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "status", "code", "title", "detail" ], "properties": { "status": { "description": "the HTTP status code applicable to this problem", "type": "string", "minLength": 3, "maxLength": 3 }, "code": { "description": "an application-specific error code. It can be the same as 'status'", "type": "string" }, "title": { "description": "a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization", "type": "string" }, "detail": { "description": "a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized", "type": "string" } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/paths/~1follow-lists/get/responses/400/content/application~1vnd.api%2Bjson/schema" } } } }, "403": { "description": "Forbidden", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/paths/~1follow-lists/get/responses/400/content/application~1vnd.api%2Bjson/schema" } } } }, "404": { "description": "Not Found", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/paths/~1follow-lists/get/responses/400/content/application~1vnd.api%2Bjson/schema" } } } }, "500": { "description": "Internal Server Error", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/paths/~1follow-lists/get/responses/400/content/application~1vnd.api%2Bjson/schema" } } } } } } }, "/follow-lists/{follow_list_id}/subscriptions/persons/{subscription_id}/alerts/auto-reviews": { "put": { "tags": [ "Persons Alerts" ], "parameters": [ { "name": "follow_list_id", "in": "path", "required": true, "description": "The ID of the Follow List that the Subscription belongs to.", "schema": { "$ref": "#/components/schemas/ID" } }, { "name": "subscription_id", "in": "path", "required": true, "description": "The ID of the Subscription.", "schema": { "$ref": "#/components/schemas/ID" } } ], "requestBody": { "description": "Batch reviews payload.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BatchAlertReviews" } ], "example": { "data": [ { "type": "reviews", "attributes": { "monitoringID": "NQZGEVsxH3oUZAFaFRA=", "status": "true-positive", "matchVersion": 6, "riskRating": "not risky", "riskComment": "not a risk for the business", "userID": "123" } } ] } } } } }, "responses": { "200": { "description": "OK", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/BatchResponse" }, "example": { "data": [ { "type": "reviews", "attributes": { "status": "success", "review": { "monitoringID": "NQZGEVsxH3oUZAFaFRA=", "status": "true-positive", "matchVersion": 2, "riskRating": "not risky", "riskComment": "not a risk for the business", "userID": "123" } } }, { "type": "reviews", "attributes": { "review": { "monitoringID": "NDZGEVsxH3oUZAFsFRA=", "status": "false-positive", "matchVersion": 1, "riskRating": "not risky", "riskComment": "not a risk for the business", "userID": "123" }, "error": { "code": "ERR-01", "message": "Resource not found" }, "status": "error" } } ] } } }, "headers": { "X-Correlation-Id": { "schema": { "type": "string", "format": "uuid", "description": "Unique request identifier" } }, "X-Ratelimit-Limit": { "schema": { "type": "integer", "description": "The number of request available in a rate limit window" } }, "X-Ratelimit-Remaining": { "schema": { "type": "integer", "description": "The number of requests left for the rate limit window" } }, "X-Ratelimit-Reset": { "schema": { "type": "integer", "description": "The Unix timestamp at which the current rate limit window resets" } } } }, "400": { "$ref": "#/paths/~1follow-lists/get/responses/400" }, "401": { "$ref": "#/paths/~1follow-lists/get/responses/401" }, "403": { "$ref": "#/paths/~1follow-lists/get/responses/403" }, "404": { "$ref": "#/paths/~1follow-lists/get/responses/404" }, "500": { "$ref": "#/paths/~1follow-lists/get/responses/500" } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-KEY" } }, "schemas": { "MatchStatus": { "type": "string", "example": "true-positive", "description": "The status of the match\n * open - Indicates that the alert requires review.\n * true-positive - Indicates that the alert is closed and that the profile was matched correctly.\n * false-positive - Indicates that the alert is closed and that the profile was matched incorrectly.\n * discarded - Indicates that the profile in the alert no longer matches the subscription due to the changes in the profile, subscription, or the follow list.\n", "enum": [ "open", "true-positive", "false-positive", "discarded" ] }, "AlertReview": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/MatchStatus" } ] }, "matchVersion": { "type": "number", "example": 1, "description": "This value can be used for version control.\nPass this value to the PUT endpoints when setting a new alert status.\nIf the provided matchVersion does not match actual value on the server it means the match has been modified in the meantime and operation will fail.\nFor auto-reviews the matchVersion should exactly match the version of the profile that you already reviewed in the Screening API." }, "riskRating": { "type": "string", "example": "High-Risk", "maxLength": 40, "description": "This is a user defined optional field that allows to set a custom risk label." }, "riskComment": { "type": "string", "maxLength": 1024, "description": "User defined optional comment added during the review.", "example": "Reviewed as true positive, no risk to the business." }, "userID": { "type": "string", "maxLength": 100, "description": "User defined optional user ID of the person/system that performed the operation.", "example": "reviewer123" } } }, "BatchAlertReviews": { "type": "object", "properties": { "data": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "reviews" }, "attributes": { "allOf": [ { "type": "object", "required": [ "monitoringID" ], "properties": { "monitoringID": { "type": "string", "example": "NQZGEVsxH3oUZAFaFRA=", "description": "The ID of the Alert for which review should be added." } } }, { "$ref": "#/components/schemas/AlertReview" } ] } } } } }, "example": { "data": [ { "type": "reviews", "attributes": { "monitoringID": "NQZGEVsxH3oUZAFaWRx=", "status": "true-positive", "riskRating": "High-Risk", "riskComment": "no risk to the business.", "userID": "reviewer123" } }, { "type": "reviews", "attributes": { "monitoringID": "ZFZGEVsxH3oUZAgaFRd=", "status": "false-positive" } }, { "type": "reviews", "attributes": { "monitoringID": "WDZGEVsxH3oUZAcaLRA=", "riskComment": "Pending review." } } ] } }, "BatchResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "reviews" }, "attributes": { "type": "object", "required": [ "review", "status" ], "properties": { "review": { "allOf": [ { "type": "object", "required": [ "monitoringID" ], "properties": { "monitoringID": { "type": "string", "example": "NQZGEVsxH3oUZAFaFRA=", "description": "The ID of the Alert that was reviewed." } } }, { "$ref": "#/components/schemas/AlertReview" } ] }, "status": { "type": "string", "description": "result status for a single record.", "example": "success", "enum": [ "success", "error" ] }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Identifier of the error.", "example": "ERR-001" }, "message": { "type": "string", "description": "Human readable error description.", "example": "Resource not found" } } } } } } } } } }, "ID": { "title": "ID of a resource.", "type": "string" } } } } ```