---
updatedAt: 2026-04-13T12:21:26.000Z
agentTools:
projectIndex: https://docs.company.info/llms.txt
---
# /follow-lists/{follow_list_id}/subscriptions/businesses/{subscription_id}/alerts
# 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/businesses/{subscription_id}/alerts": {
"get": {
"tags": [
"Business Alerts"
],
"parameters": [
{
"name": "follow_list_id",
"in": "path",
"required": true,
"description": "The ID of the Follow List where a Subscription will be created.",
"schema": {
"$ref": "#/components/schemas/ID"
}
},
{
"name": "subscription_id",
"in": "path",
"required": true,
"description": "The ID of the Subscription that is used to get Alerts. All Alerts are the matching profiles for the given Subscription.",
"schema": {
"$ref": "#/components/schemas/ID"
}
},
{
"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/ListOfBusinessAlerts"
},
"example": {
"data": [
{
"type": "reviews",
"id": "NQZGEVkxH3oUZAFaFRA=",
"attributes": {
"countries": [
"US"
],
"currentStatus": "true-positive",
"datasets": [
"RRE",
"POI"
],
"match": "BMI Corporation",
"matchVersion": 7,
"name": "BMI Corporation",
"businessID": "NQZGEVkxH3pAYV0KQhQTXV0gFFJ9QAFKUXJZWmENWl1SJ2QhBnlBKWYmElp2QFp5f28EURVGFFxTdgBaCABXGWFTVwFUchY=",
"score": 100,
"version": 1673422459727
},
"links": {
"self": "https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/businesses/01H2TC48NQGJ1RXJBQC3GR72QC/alerts/NQZGEVkxH3oUZAFaFRA="
}
}
],
"links": {
"next": "https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/businesses/alerts?page[cursor]=eyJnc2kxaGFQ0dHUjdUUVYifQ==&page[size]=1",
"self": "https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/businesses/alerts?page[size]=1"
}
}
}
},
"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": {
"ListOfFollowList": {
"title": "List of Follow Lists",
"description": "Paginated response with list of Follow Lists",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FollowListObject"
}
},
"links": {
"type": "object",
"properties": {
"next": {
"title": "JSON:API Link",
"description": "A JSON:API link can be either a URL string or a structured link object.",
"oneOf": [
{
"type": "string",
"format": "url",
"example": "https://example.com/"
},
{
"title": "JSON:API Link Object",
"description": "a structured representation of a URL",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "/organizations/"
},
"meta": {
"type": "object",
"example": {
"count": "10"
}
}
}
}
]
},
"self": {
"$ref": "#/components/schemas/ListOfFollowList/properties/links/properties/next"
}
}
}
}
},
"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"
]
},
"BusinessProfileDatasetsSchema": {
"type": "array",
"minItems": 1,
"description": "The profile datasets\n * PEP-LINKED - Only linked PEPs (PEP by Association)\n * SAN-CURRENT - Only current Sanctions\n * SAN-FORMER - Only former Sanctions\n * INS - Insolvency\n * RRE - Reputational Risk Exposure\n * POI - Profile Of Interest\n * REL - Regulatory Enforcement List\n * SOE-CURRENT - Only current SOE\n * SOE-FORMER - Only former SOE\n * GRI - Gambling Risk Intelligence.\n",
"example": [
"INS",
"PEP-LINKED",
"POI",
"REL",
"RRE",
"SAN-CURRENT",
"SAN-FORMER",
"GRI"
],
"items": {
"type": "string",
"enum": [
"PEP-LINKED",
"SAN-CURRENT",
"SAN-FORMER",
"INS",
"RRE",
"POI",
"REL",
"SOE-CURRENT",
"SOE-FORMER",
"GRI"
]
}
},
"ListOfBusinessAlerts": {
"title": "List of Business Alerts",
"description": "Paginated response with list of Business Alerts. Every Alert contains a matching profile and a reference to full profile in Compliance Screening API.",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FullBusinessAlertObject"
}
},
"links": {
"type": "object",
"properties": {
"next": {
"$ref": "#/components/schemas/ListOfFollowList/properties/links/properties/next"
},
"self": {
"$ref": "#/components/schemas/ListOfFollowList/properties/links/properties/next"
}
}
}
}
},
"FullBusinessAlertObject": {
"title": "Business Alert object",
"description": "a Business Alert object structure",
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/ID"
},
"type": {
"type": "string",
"example": "alerts"
},
"attributes": {
"$ref": "#/components/schemas/BaseBusinessAlert"
},
"links": {
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/ListOfFollowList/properties/links/properties/next"
}
}
}
}
},
"BaseBusinessAlert": {
"type": "object",
"required": [
"currentStatus",
"datasets",
"version",
"businessID",
"score",
"match",
"name",
"countries",
"matchVersion"
],
"properties": {
"currentStatus": {
"$ref": "#/components/schemas/MatchStatus"
},
"version": {
"type": "integer",
"example": 15346444345,
"description": "The version number can be used to detect when a profile has changed."
},
"businessID": {
"type": "string",
"description": "The profile Id can be used to retrieve the full profile of the business in the Compliance Screening API.",
"example": "NQZGEVkxH3pAYV0KQhQTXV0gFFJ9QAFKUXJZWmENWl1SJ2QhBnlBKWYmElp2QFp5f28EURVGFFxTdgBaCABXGWFTVwFUchY="
},
"score": {
"minimum": 50,
"maximum": 100,
"type": "integer",
"example": 99,
"description": "The match score of the profile."
},
"match": {
"type": "string",
"example": "Jane Doe",
"description": "The name on the profile that has been matched in the search."
},
"name": {
"type": "string",
"example": "BMI Corporation",
"description": "The primary name on the profile."
},
"countries": {
"minItems": 0,
"type": "array",
"example": [
"US"
],
"items": {
"type": "string"
},
"description": "The list of countries from the addresses and nationalities of the profile."
},
"datasets": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessProfileDatasetsSchema"
}
]
},
"matchVersion": {
"type": "number",
"example": 1,
"description": "This value can be used for version control.\nPass this value when setting a new alert status.\nIf the provided matchVersion does not match actual value on the server it means the alert has been modified in the meantime and operation will fail."
}
}
},
"Page": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"default": 10,
"description": "The number of records to return in each page."
},
"cursor": {
"type": "string",
"example": "CEcTEwIRUV9RDw==",
"description": "Leaving this blank will return the first page. Otherwise you can provide the cursor from a previous request to iterate to the next page."
}
}
},
"ID": {
"title": "ID of a resource.",
"type": "string"
}
}
}
}
```