---
updatedAt: 2026-04-13T12:21:26.000Z
agentTools:
projectIndex: https://docs.company.info/llms.txt
---
# /follow-lists
# 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"
}
}
}
}
}
},
"post": {
"tags": [
"Follow Lists"
],
"requestBody": {
"description": "Follow List payload.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NewFollowList"
}
],
"example": {
"data": {
"type": "follow-lists",
"attributes": {
"dateOfBirthMatching": "withinThreeYears",
"name": "Follow List - 1",
"threshold": 85,
"frequency": "daily",
"datasets": [
"PEP"
]
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/FollowList"
},
"example": {
"data": {
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"type": "follow-lists",
"attributes": {
"dateOfBirthMatching": "withinThreeYears",
"name": "Follow List - 1",
"threshold": 85,
"frequency": "daily",
"datasets": [
"PEP"
],
"dateOfBirthRequired": false,
"countryRequired": false,
"matching": "fuzzy",
"pepTiers": []
},
"links": {
"self": "https://example.com/follow-lists/01ARZ3NDEKTSV4RRFFQ69G5FAV"
}
}
}
}
},
"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"
}
}
}
}
},
"FollowList": {
"title": "Follow List",
"description": "All the information about a Follow List. Follow List is a collection of Subscriptions",
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/FollowListObject"
}
}
},
"FollowListObject": {
"title": "Follow List object",
"description": "a Follow List object structure",
"type": "object",
"required": [
"dateOfBirthMatching",
"dateOfBirthRequired",
"countryRequired",
"matching",
"pepTiers"
],
"properties": {
"id": {
"$ref": "#/components/schemas/ID"
},
"type": {
"type": "string",
"example": "follow-lists"
},
"attributes": {
"allOf": [
{
"$ref": "#/components/schemas/BaseFollowList"
}
]
},
"links": {
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/ListOfFollowList/properties/links/properties/next"
}
}
}
}
},
"NewFollowList": {
"title": "New Follow List",
"description": "a new Follow List object structure",
"type": "object",
"required": [
"dateOfBirthMatching",
"dateOfBirthRequired",
"countryRequired",
"matching",
"pepTiers"
],
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "follow-lists"
},
"attributes": {
"$ref": "#/components/schemas/BaseFollowList"
}
}
}
}
},
"BaseFollowList": {
"type": "object",
"required": [
"name",
"threshold",
"frequency",
"datasets"
],
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"example": "Follow List - 1",
"description": "A name of the Follow List."
},
"threshold": {
"type": "integer",
"minimum": 75,
"maximum": 100,
"example": 85,
"description": "Alerts with matching profiles with scores below this value will not be shown."
},
"frequency": {
"type": "string",
"enum": [
"daily",
"weekly",
"monthly",
"halfAYear",
"annual"
],
"example": "daily",
"description": "The frequency with which all Subscriptions in the Follow List will be screened."
},
"datasets": {
"type": "array",
"minItems": 1,
"description": "Specifies which datasets will be searched\n * PEP - Politically Exposed Persons (All)\n * PEP-CURRENT - Only current PEPs\n * PEP-FORMER - Only former PEPs\n * PEP-LINKED - Only linked PEPs (PEP by Association)\n * SAN - Sanctioned (All)\n * SAN-CURRENT - Only current Sanctions\n * SAN-FORMER - Only former Sanctions\n * INS - Insolvency\n * RRE - Reputational Risk Exposure\n * DD - Disqualified Director\n * POI - Profile Of Interest\n * REL - Regulatory Enforcement List\n * SOE - State Owned Enterprise\n * SOE-CURRENT - Only current SOEs\n * SOE-FORMER - Only former SOEs",
"example": [
"PEP"
],
"items": {
"type": "string",
"enum": [
"PEP",
"PEP-CURRENT",
"PEP-FORMER",
"PEP-LINKED",
"SAN",
"SAN-CURRENT",
"SAN-FORMER",
"INS",
"RRE",
"DD",
"POI",
"REL",
"SOE",
"SOE-CURRENT",
"SOE-FORMER"
]
}
},
"scheduleDayOfTheWeek": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"example": "friday",
"description": "Specifies a day of the week on which screening should be done.\nIt is required and allowed only when the frequency is set to weekly."
},
"scheduleDayOfTheMonth": {
"type": "integer",
"minimum": 1,
"maximum": 31,
"example": 31,
"description": "Specifies a day of the month on which screening should be done.\nIt is required and allowed only when the frequency is set to monthly, halfAYear or annual."
},
"scheduleMonth": {
"type": "string",
"enum": [
"january",
"february",
"march",
"april",
"may",
"june",
"july",
"august",
"september",
"october",
"november",
"december"
],
"example": "january",
"description": "Specifies a month on which screening should be done.\nIt is required and allowed only when the frequency is set to halfAYear or annual."
},
"dateOfBirthMatching": {
"type": "string",
"enum": [
"exact",
"sameYear",
"withinOneYear",
"withinTwoYears",
"withinThreeYears",
"withinFourYears",
"withinFiveYears"
],
"default": "sameYear",
"example": "withinThreeYears",
"description": "Determines the accuracy of the date of birth matching\n * exact - The date of birth must be a perfect match to produce a hit.\n * sameYear - The date of birth just needs to be in the same calendar year to produce a hit.\n * withinOneYear - The date of birth must be within 1 year of the date specified in order to produce a hit.\n * withinTwoYears - The date of birth must be within 2 years of the date specified in order to produce a hit.\n * withinThreeYears - The date of birth must be within 3 years of the date specified in order to produce a hit.\n * withinFourYears - The date of birth must be within 4 years of the date specified in order to produce a hit.\n * withinFiveYears - The date of birth must be within 5 years of the date specified in order to produce a hit.\n"
},
"dateOfBirthRequired": {
"type": "boolean",
"default": false,
"example": false,
"description": "Tells if profiles with unknown dates of birth should be filtered out of the screening results for Subscriptions with a specified date of birth.\n\nIf set to false (default value), and dateOfBirth is specified, profiles with no date of birth will appear in the results with a small penalty applied due to the lack of dateOfBirth match.\n\nIf set to true, and dateOfBirth is specified, profiles with no date of birth will NOT appear in the results.\n\nIf the dateOfBirth is not specified in the Subscription, the attribute is ignored (profiles with no date of birth will appear in the screening results with no penalty)."
},
"countryRequired": {
"type": "boolean",
"default": false,
"example": false,
"description": "Tells if profiles with unknown country and no nationality should be filtered out of the Alerts for a Subscription with a specified country.\n\nIf set to false (default value), and country is specified, profiles with no country and no nationality will appear in the results with a small penalty applied due to the lack of a country match.\n\nIf set to true, and country is specified, profiles with no country and no nationality will NOT appear in the results.\n\nIf the country is not specified in the Subscription, the attribute is ignored (profiles with no country and no nationality will appear in screening results with no penalty)."
},
"matching": {
"type": "string",
"enum": [
"fuzzy",
"strict"
],
"default": "fuzzy",
"example": "fuzzy",
"description": "Defines what name matching algorithm is used for profile screening.\n\nThe Fuzzy algorithm is the default and applies all of our fuzzy matching techniques to ensure the most accurate results.\n\nThe Strict algorithm uses some fuzzy matching, but is more restrictive in its approach and may miss some alerts (matching profiles) if the exact name is not known. \n\nWe strongly recommend using the Fuzzy algorithm for the best results and only using the Strict algorithm to reduce the number of Alerts to the bare minimum, when the exact name is known."
},
"pepTiers": {
"type": "array",
"minItems": 0,
"items": {
"type": "string",
"enum": [
"PEP Tier 1",
"PEP Tier 2",
"PEP Tier 3"
]
},
"example": [
"PEP Tier 1"
],
"description": "When screening the PEP dataset, define what tiers of the PEP profiles should be included in the results. Where PEP Tier 1 indicates senior roles, PEP Tier 2 - middle-ranking, and PEP Tier 3 - junior officials. If the PEP Dataset is NOT included on the list of datasets to screen, then this value is ignored. The PEP Tier filter does not apply to PEP-LINKED Profiles."
}
}
},
"ID": {
"title": "ID of a resource.",
"type": "string"
}
}
}
}
```