{"components":{"responses":{"BadRequest":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Bad Request"},"Forbidden":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Forbidden"},"InternalServerError":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Internal Server Error"},"NotFound":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Not Found"},"Unauthorized":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Unauthorized"}},"schemas":{"AlertReview":{"properties":{"matchVersion":{"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.","example":1,"type":"number"},"riskComment":{"description":"User defined optional comment added during the review.","example":"Reviewed as true positive, no risk to the business.","maxLength":1024,"type":"string"},"riskRating":{"description":"This is a user defined optional field that allows to set a custom risk label.","example":"High-Risk","maxLength":40,"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/MatchStatus"}]},"userID":{"description":"User defined optional user ID of the person/system that performed the operation.","example":"reviewer123","maxLength":100,"type":"string"}},"type":"object"},"BaseBusinessAlert":{"properties":{"businessID":{"description":"The profile Id can be used to retrieve the full profile of the business in the Compliance Screening API.","example":"NQZGEVkxH3pAYV0KQhQTXV0gFFJ9QAFKUXJZWmENWl1SJ2QhBnlBKWYmElp2QFp5f28EURVGFFxTdgBaCABXGWFTVwFUchY=","type":"string"},"countries":{"description":"The list of countries from the addresses and nationalities of the profile.","example":["US"],"items":{"type":"string"},"type":"array"},"currentStatus":{"$ref":"#/components/schemas/MatchStatus"},"datasets":{"allOf":[{"$ref":"#/components/schemas/BusinessProfileDatasetsSchema"}]},"match":{"description":"The name on the profile that has been matched in the search.","example":"Jane Doe","type":"string"},"matchVersion":{"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.","example":1,"type":"number"},"name":{"description":"The primary name on the profile.","example":"BMI Corporation","type":"string"},"score":{"description":"The match score of the profile.","example":99,"maximum":100,"minimum":50,"type":"integer"},"version":{"description":"The version number can be used to detect when a profile has changed.","example":15346444345,"type":"integer"}},"required":["currentStatus","datasets","version","businessID","score","match","name","countries","matchVersion"],"type":"object"},"BaseBusinessSubscription":{"properties":{"countries":{"description":"The list of countries from the addresses and nationalities of the profile.","example":["US"],"items":{"type":"string"},"type":"array"},"name":{"description":"The full name of the business you want to monitor.","example":"BMI Corporation","maxLength":200,"minLength":1,"type":"string"}},"required":["name","countries"],"type":"object"},"BaseFollowList":{"properties":{"countryRequired":{"default":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).","example":false,"type":"boolean"},"datasets":{"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":{"enum":["PEP","PEP-CURRENT","PEP-FORMER","PEP-LINKED","SAN","SAN-CURRENT","SAN-FORMER","INS","RRE","DD","POI","REL","SOE","SOE-CURRENT","SOE-FORMER"],"type":"string"},"minItems":1,"type":"array"},"dateOfBirthMatching":{"default":"sameYear","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","enum":["exact","sameYear","withinOneYear","withinTwoYears","withinThreeYears","withinFourYears","withinFiveYears"],"example":"withinThreeYears","type":"string"},"dateOfBirthRequired":{"default":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).","example":false,"type":"boolean"},"frequency":{"description":"The frequency with which all Subscriptions in the Follow List will be screened.","enum":["daily","weekly","monthly","halfAYear","annual"],"example":"daily","type":"string"},"matching":{"default":"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.","enum":["fuzzy","strict"],"example":"fuzzy","type":"string"},"name":{"description":"A name of the Follow List.","example":"Follow List - 1","maxLength":100,"minLength":1,"type":"string"},"pepTiers":{"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.","example":["PEP Tier 1"],"items":{"enum":["PEP Tier 1","PEP Tier 2","PEP Tier 3"],"type":"string"},"type":"array"},"scheduleDayOfTheMonth":{"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.","example":31,"maximum":31,"minimum":1,"type":"integer"},"scheduleDayOfTheWeek":{"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.","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"example":"friday","type":"string"},"scheduleMonth":{"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.","enum":["january","february","march","april","may","june","july","august","september","october","november","december"],"example":"january","type":"string"},"threshold":{"description":"Alerts with matching profiles with scores below this value will not be shown.","example":85,"maximum":100,"minimum":75,"type":"integer"}},"required":["name","threshold","frequency","datasets"],"type":"object"},"BasePersonAlert":{"properties":{"countries":{"description":"The list of countries from the addresses and nationalities of the profile.","example":["US"],"items":{"type":"string"},"type":"array"},"currentStatus":{"$ref":"#/components/schemas/MatchStatus"},"datasets":{"allOf":[{"$ref":"#/components/schemas/PersonProfileDatasetsSchema"}]},"datesOfBirth":{"example":["1994","1994-08-22"],"items":{"description":"Date in either YYYY-MM-DD or YYYY ISO format.","type":"string"},"type":"array"},"gender":{"description":"The gender of the person, if known.","enum":["male","female"],"example":"male","type":"string"},"match":{"description":"The name on the profile that has been matched in the search.","example":"Jane Doe","type":"string"},"matchVersion":{"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.","example":1,"type":"number"},"name":{"description":"The primary name on the profile.","example":"Jane Marie Doe","type":"string"},"pepTier":{"description":"Defines the PEP tier of the matched person. Where PEP Tier 1 indicates senior roles, PEP Tier 2 - middle-ranking, and PEP Tier 3 - junior officials.","enum":["PEP Tier 1","PEP Tier 2","PEP Tier 3"],"example":"PEP Tier 1","type":"string"},"personID":{"description":"The profile Id can be used to retrieve the full profile of the person in the Compliance Screening API.","example":"NQZGEVkxH3pAYV0KQhQTXV0gFFJ9QAFKUXJZWmENWl1SJ2QhBnlBKWYmElp2QFp5f28EURVGFFxTdgBaCABXGWFTVwFUchY=","type":"string"},"profileImage":{"description":"The primary profile image.","type":"string"},"score":{"description":"The match score of the profile.","example":99,"maximum":100,"minimum":50,"type":"integer"},"version":{"description":"The version number can be used to detect when a profile has changed.","example":15346444345,"type":"integer"}},"required":["currentStatus","datasets","datesOfBirth","version","personID","score","match","name","countries","matchVersion"],"type":"object"},"BasePersonSubscription":{"properties":{"countries":{"description":"The list of countries from the addresses and nationalities of the profile.","example":["US"],"items":{"type":"string"},"type":"array"},"dateOfBirth":{"description":"Date in either YYYY-MM-DD or YYYY ISO format.","example":"1991-07-22","type":"string"},"gender":{"description":"The gender of the person.","enum":["male","female"],"example":"female","type":"string"},"name":{"description":"The full name of the person you want to monitor.","example":"Jane Doe","maxLength":200,"minLength":1,"type":"string"}},"required":["name","countries"],"type":"object"},"BaseSubscription":{"properties":{"createdDateTimeISO":{"description":"The timestamp that the record was first created.","example":"2021-10-05T10:10:08.270Z","type":"string"},"discardedCount":{"description":"The number of Alerts already discarded.","example":0,"type":"integer"},"falsePositiveCount":{"description":"The number of Alerts already closed as false positive.","example":0,"type":"integer"},"lastUpdatedDateTimeISO":{"description":"The last time the record was updated by the user.","example":"2021-10-05T10:10:08.270Z","type":"string"},"openCount":{"description":"The number of open Alerts for the Subscription.","example":1,"type":"integer"},"truePositiveCount":{"description":"The number of Alerts already closed as true positive.","example":0,"type":"integer"}},"required":["openCount","falsePositiveCount","truePositiveCount","discardedCount","createdDateTimeISO","lastUpdatedDateTimeISO"],"type":"object"},"BatchAlertReviews":{"example":{"data":[{"attributes":{"monitoringID":"NQZGEVsxH3oUZAFaWRx=","riskComment":"no risk to the business.","riskRating":"High-Risk","status":"true-positive","userID":"reviewer123"},"type":"reviews"},{"attributes":{"monitoringID":"ZFZGEVsxH3oUZAgaFRd=","status":"false-positive"},"type":"reviews"},{"attributes":{"monitoringID":"WDZGEVsxH3oUZAcaLRA=","riskComment":"Pending review."},"type":"reviews"}]},"properties":{"data":{"items":{"properties":{"attributes":{"allOf":[{"properties":{"monitoringID":{"description":"The ID of the Alert for which review should be added.","example":"NQZGEVsxH3oUZAFaFRA=","type":"string"}},"required":["monitoringID"],"type":"object"},{"$ref":"#/components/schemas/AlertReview"}]},"type":{"example":"reviews","type":"string"}},"type":"object"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"BatchResponse":{"properties":{"data":{"items":{"properties":{"attributes":{"properties":{"error":{"properties":{"code":{"description":"Identifier of the error.","example":"ERR-001","type":"string"},"message":{"description":"Human readable error description.","example":"Resource not found","type":"string"}},"required":["code","message"],"type":"object"},"review":{"allOf":[{"properties":{"monitoringID":{"description":"The ID of the Alert that was reviewed.","example":"NQZGEVsxH3oUZAFaFRA=","type":"string"}},"required":["monitoringID"],"type":"object"},{"$ref":"#/components/schemas/AlertReview"}]},"status":{"description":"result status for a single record.","enum":["success","error"],"example":"success","type":"string"}},"required":["review","status"],"type":"object"},"type":{"example":"reviews","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"BusinessProfileDatasetsSchema":{"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":{"enum":["PEP-LINKED","SAN-CURRENT","SAN-FORMER","INS","RRE","POI","REL","SOE-CURRENT","SOE-FORMER","GRI"],"type":"string"},"minItems":1,"type":"array"},"FollowList":{"description":"All the information about a Follow List. Follow List is a collection of Subscriptions","properties":{"data":{"$ref":"#/components/schemas/FollowListObject"}},"title":"Follow List","type":"object"},"FollowListObject":{"description":"a Follow List object structure","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseFollowList"},{"required":["dateOfBirthMatching","dateOfBirthRequired","countryRequired","matching","pepTiers"],"type":"object"}]},"id":{"$ref":"#/components/schemas/ID"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"type":{"example":"follow-lists","type":"string"}},"title":"Follow List object","type":"object"},"FollowListStatistics":{"properties":{"businessDiscardedAlertsCount":{"description":"The number of discarded business Alerts in the given Follow List.","example":5,"type":"integer"},"businessFalsePositiveAlertsCount":{"description":"The number of false-positive business Alerts in the given Follow List.","example":5,"type":"integer"},"businessOpenAlertsCount":{"description":"The number of open business Subscriptions in the given Follow List.","example":5,"type":"integer"},"businessOpenSubscriptionsCount":{"description":"The number of open business Subscriptions in the given Follow List.","example":5,"type":"integer"},"businessSubscriptionsCount":{"description":"The number of business Subscriptions in the given Follow List.","example":5,"type":"integer"},"businessTruePositiveAlertsCount":{"description":"The number of true-positive business Alerts in the given Follow List.","example":5,"type":"integer"},"lastScreenedDateISO":{"description":"Date of the last completed screening.","example":"2022-06-11","type":"string"},"personDiscardedAlertsCount":{"description":"The number of discarded person Alerts in the given Follow List.","example":5,"type":"integer"},"personFalsePositiveAlertsCount":{"description":"The number of false-positive person Alerts in the given Follow List.","example":5,"type":"integer"},"personOpenAlertsCount":{"description":"The number of open person Alerts in the given Follow List.","example":5,"type":"integer"},"personOpenSubscriptionsCount":{"description":"The number of open person Subscriptions in the given Follow List.","example":5,"type":"integer"},"personSubscriptionsCount":{"description":"The number of person Subscriptions in the given Follow List.","example":5,"type":"integer"},"personTruePositiveAlertsCount":{"description":"The number of true-positive person Alerts in the given Follow List.","example":5,"type":"integer"}},"required":["businessSubscriptionsCount","personSubscriptionsCount","personOpenSubscriptionsCount","personOpenAlertsCount","personFalsePositiveAlertsCount","personTruePositiveAlertsCount","personDiscardedAlertsCount","businessOpenSubscriptionsCount","businessOpenAlertsCount","businessFalsePositiveAlertsCount","businessTruePositiveAlertsCount","businessDiscardedAlertsCount"],"type":"object"},"FullBusinessAlert":{"description":"All the information about a Business Alert. Business Alert is a record with a profile that matches search criteria in the Subscription. Contains an ID that can be used to fetch full profile in Compliance Screening API.","properties":{"data":{"$ref":"#/components/schemas/FullBusinessAlertObject"}},"title":"Business Subscription","type":"object"},"FullBusinessAlertObject":{"description":"a Business Alert object structure","properties":{"attributes":{"$ref":"#/components/schemas/BaseBusinessAlert"},"id":{"$ref":"#/components/schemas/ID"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"type":{"example":"alerts","type":"string"}},"title":"Business Alert object","type":"object"},"FullBusinessSubscription":{"description":"All the information about a business subscription. Business subscription is a record in a Follow List with search criteria for a profile that you want to monitor.","properties":{"data":{"$ref":"#/components/schemas/FullBusinessSubscriptionObject"}},"title":"Business Subscription","type":"object"},"FullBusinessSubscriptionObject":{"description":"a Business Subscription object structure","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseSubscription"},{"$ref":"#/components/schemas/BaseBusinessSubscription"}]},"id":{"$ref":"#/components/schemas/ID"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"type":{"example":"subscriptions","type":"string"}},"title":"Business Subscription object","type":"object"},"FullFollowList":{"description":"All the information about a Follow List. Follow List is a collection of Subscriptions","properties":{"data":{"$ref":"#/components/schemas/FullFollowListObject"}},"title":"Follow List","type":"object"},"FullFollowListObject":{"description":"a Follow List object structure including statistics","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseFollowList"},{"$ref":"#/components/schemas/FollowListStatistics"},{"required":["dateOfBirthMatching","dateOfBirthRequired","countryRequired","matching","pepTiers"],"type":"object"}]},"id":{"$ref":"#/components/schemas/ID"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"type":{"example":"follow-lists","type":"string"}},"title":"Follow List object","type":"object"},"FullPersonAlert":{"description":"All the information about a Person Alert. Person Alert is a record with a profile that matches search criteria in the Subscription. Contains an ID that can be used to fetch full profile in Compliance Screening API.","properties":{"data":{"$ref":"#/components/schemas/FullPersonAlertObject"}},"title":"Person Subscription","type":"object"},"FullPersonAlertObject":{"description":"a Person Alert object structure","properties":{"attributes":{"$ref":"#/components/schemas/BasePersonAlert"},"id":{"$ref":"#/components/schemas/ID"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"type":{"example":"alerts","type":"string"}},"title":"Person Alert object","type":"object"},"FullPersonSubscription":{"description":"All the information about a Person Subscription. Person Subscription is a record in a Follow List with search criteria for a profile that you want to monitor.","properties":{"data":{"$ref":"#/components/schemas/FullPersonSubscriptionObject"}},"title":"Person Subscription","type":"object"},"FullPersonSubscriptionObject":{"description":"a Person Subscription object structure","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseSubscription"},{"$ref":"#/components/schemas/BasePersonSubscription"}]},"id":{"$ref":"#/components/schemas/ID"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"type":{"example":"subscriptions","type":"string"}},"title":"Person Subscription object","type":"object"},"ID":{"title":"ID of a resource.","type":"string"},"JSONAPIErrorResponse":{"properties":{"errors":{"items":{"properties":{"code":{"description":"an application-specific error code. It can be the same as 'status'","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"},"status":{"description":"the HTTP status code applicable to this problem","maxLength":3,"minLength":3,"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"}},"required":["status","code","title","detail"],"type":"object"},"minItems":1,"title":"An array of Error objects","type":"array"}},"required":["errors"],"title":"JSON:API Error Response","type":"object"},"JSONAPILink":{"description":"A JSON:API link can be either a URL string or a structured link object.","oneOf":[{"example":"https://example.com/","format":"url","type":"string"},{"$ref":"#/components/schemas/JSONAPILinkObject"}],"title":"JSON:API Link"},"JSONAPILinkObject":{"description":"a structured representation of a URL","properties":{"href":{"example":"/organizations/<cin>","type":"string"},"meta":{"example":{"count":"10"},"type":"object"}},"required":["href"],"title":"JSON:API Link Object","type":"object"},"ListOfAlertReviews":{"properties":{"data":{"items":{"properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/AlertReview"}],"properties":{"dateTimeISO":{"description":"The dateTime that the match review was created.","example":"2010-10-10T10:10:10.100Z","type":"string"}},"required":["dateTimeISO"],"type":"object"},"type":{"example":"reviews","type":"string"}},"type":"object"},"type":"array"},"links":{"properties":{"next":{"$ref":"#/components/schemas/JSONAPILink"},"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"}},"type":"object"},"ListOfBusinessAlerts":{"description":"Paginated response with list of Business Alerts. Every Alert contains a matching profile and a reference to full profile in Compliance Screening API.","properties":{"data":{"items":{"$ref":"#/components/schemas/FullBusinessAlertObject"},"type":"array"},"links":{"properties":{"next":{"$ref":"#/components/schemas/JSONAPILink"},"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"}},"title":"List of Business Alerts","type":"object"},"ListOfBusinessSubscriptions":{"description":"Paginated response with list of Business Subscriptions","properties":{"data":{"items":{"$ref":"#/components/schemas/FullBusinessSubscriptionObject"},"type":"array"},"links":{"properties":{"next":{"$ref":"#/components/schemas/JSONAPILink"},"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"meta":{"$ref":"#/components/schemas/SubscriptionStatistics"}},"title":"List of Business Subscriptions","type":"object"},"ListOfFollowList":{"description":"Paginated response with list of Follow Lists","properties":{"data":{"items":{"$ref":"#/components/schemas/FollowListObject"},"type":"array"},"links":{"properties":{"next":{"$ref":"#/components/schemas/JSONAPILink"},"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"}},"title":"List of Follow Lists","type":"object"},"ListOfPersonAlerts":{"description":"Paginated response with list of Person Alerts. Every Alert contains a matching profile and a reference to full profile in Compliance Screening API.","properties":{"data":{"items":{"$ref":"#/components/schemas/FullPersonAlertObject"},"type":"array"},"links":{"properties":{"next":{"$ref":"#/components/schemas/JSONAPILink"},"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"}},"title":"List of Person Alerts","type":"object"},"ListOfPersonSubscriptions":{"description":"Paginated response with list of Person Subscriptions","properties":{"data":{"items":{"$ref":"#/components/schemas/FullPersonSubscriptionObject"},"type":"array"},"links":{"properties":{"next":{"$ref":"#/components/schemas/JSONAPILink"},"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"meta":{"$ref":"#/components/schemas/SubscriptionStatistics"}},"title":"List of Person Subscriptions","type":"object"},"MatchStatus":{"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"],"example":"true-positive","type":"string"},"NewBusinessSubscription":{"description":"a new Business Subscription object structure","properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/BaseBusinessSubscription"},"type":{"example":"subscriptions","type":"string"}},"type":"object"}},"title":"New Business Subscription object","type":"object"},"NewFollowList":{"description":"a new Follow List object structure","properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/BaseFollowList"},"type":{"example":"follow-lists","type":"string"}},"type":"object"}},"title":"New Follow List","type":"object"},"NewPersonSubscription":{"description":"a new Person Subscription object structure","properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/BasePersonSubscription"},"type":{"example":"subscriptions","type":"string"}},"type":"object"}},"title":"New Person Subscription object","type":"object"},"Page":{"properties":{"cursor":{"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.","example":"CEcTEwIRUV9RDw==","type":"string"},"size":{"default":10,"description":"The number of records to return in each page.","type":"integer"}},"type":"object"},"PersonProfileDatasetsSchema":{"description":"The profile datasets\n * PEP-CURRENT - Only current PEPs\n * PEP-FORMER - Only former PEPs\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 * DD - Disqualified Director\n * POI - Profile Of Interest\n * REL - Regulatory Enforcement List\n * GRI - Gambling Risk Intelligence.\n","example":["DD","INS","PEP-CURRENT","PEP-FORMER","PEP-LINKED","POI","REL","RRE","SAN-CURRENT","SAN-FORMER","GRI"],"items":{"enum":["PEP-CURRENT","PEP-FORMER","PEP-LINKED","SAN-CURRENT","SAN-FORMER","INS","RRE","DD","POI","REL","GRI"],"type":"string"},"minItems":1,"type":"array"},"SubscriptionStatistics":{"properties":{"discardedAlertsCount":{"description":"The number of discarded Alerts (matching profiles) in all subscriptions in the given Follow List.","example":1,"type":"integer"},"falsePositiveAlertsCount":{"description":"The number of false-positive Alerts (matching profiles) in all subscriptions in the given Follow List.","example":3,"type":"integer"},"openAlertsCount":{"description":"The number of open Alerts (matching profiles) in all subscriptions in the given Follow List.","example":3,"type":"integer"},"openSubscriptionsCount":{"description":"The number of open subscriptions in the given Follow List.","example":1,"type":"integer"},"subscriptionsCount":{"description":"The number of subscriptions in the given Follow List.","example":5,"type":"integer"},"truePositiveAlertsCount":{"description":"The number of true-positive Alerts (matching profiles) in all subscriptions in the given Follow List.","example":1,"type":"integer"}},"required":["subscriptionsCount","openSubscriptionsCount","openAlertsCount","falsePositiveAlertsCount","truePositiveAlertsCount","discardedAlertsCount"],"type":"object"},"UpdatedBusinessSubscription":{"description":"The information about a Business Subscription without statistics like number of Alerts, etc. Business Subscription is a record in a Follow List with search criteria for a profile that you want to monitor.","properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/BaseBusinessSubscription"},"id":{"$ref":"#/components/schemas/ID"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"type":{"example":"follow-lists","type":"string"}},"type":"object"}},"title":"Business Subscription","type":"object"},"UpdatedPersonSubscription":{"description":"The information about a Person Subscription without statistics like number of Alerts, etc. Person Subscription is a record in a Follow List with search criteria for a profile that you want to monitor.","properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/BasePersonSubscription"},"id":{"$ref":"#/components/schemas/ID"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"type":{"example":"follow-lists","type":"string"}},"type":"object"}},"title":"Person Subscription","type":"object"}},"securitySchemes":{"ApiKeyAuth":{"in":"header","name":"X-API-KEY","type":"apiKey"}}},"info":{"description":"Compliance Monitoring","title":"Compliance Monitoring","version":"2.0.0"},"openapi":"3.0.3","paths":{"/follow-lists":{"get":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"getFollowLists","parameters":[{"description":"`size`defines the number of records to return in each page. default value: 10, maximum value: 20. <br>`cursor`specifies the next page cursor.","in":"query","name":"page","schema":{"$ref":"#/components/schemas/Page"},"style":"deepObject"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ListOfFollowList"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Follow Lists"]},"post":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"postFollowLists","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NewFollowList"}],"example":{"data":{"attributes":{"datasets":["PEP"],"dateOfBirthMatching":"withinThreeYears","frequency":"daily","name":"Follow List - 1","threshold":85},"type":"follow-lists"}}}}},"description":"Follow List payload."},"responses":{"201":{"content":{"application/vnd.api+json":{"example":{"data":{"attributes":{"countryRequired":false,"datasets":["PEP"],"dateOfBirthMatching":"withinThreeYears","dateOfBirthRequired":false,"frequency":"daily","matching":"fuzzy","name":"Follow List - 1","pepTiers":[],"threshold":85},"id":"01ARZ3NDEKTSV4RRFFQ69G5FAV","links":{"self":"https://example.com/follow-lists/01ARZ3NDEKTSV4RRFFQ69G5FAV"},"type":"follow-lists"}},"schema":{"$ref":"#/components/schemas/FollowList"}}},"description":"Created","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Follow Lists"]}},"/follow-lists/{follow_list_id}":{"delete":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"deleteFollowListsByFollow_list_id","parameters":[{"description":"The ID of the Follow List that will be deleted.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"responses":{"204":{"description":"No Content","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Follow Lists"]},"get":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"getFollowListsByFollow_list_id","parameters":[{"description":"The ID of the Follow List that will be returned.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":{"attributes":{"businessDiscardedAlertsCount":0,"businessFalsePositiveAlertsCount":0,"businessOpenAlertsCount":0,"businessOpenSubscriptionsCount":0,"businessSubscriptionsCount":0,"businessTruePositiveAlertsCount":0,"countryRequired":false,"datasets":["PEP"],"dateOfBirthMatching":"withinThreeYears","dateOfBirthRequired":false,"frequency":"daily","lastScreenedDateISO":"2022-06-11","matching":"fuzzy","name":"Follow List - 1","pepTiers":[],"personDiscardedAlertsCount":0,"personFalsePositiveAlertsCount":0,"personOpenAlertsCount":0,"personOpenSubscriptionsCount":0,"personSubscriptionsCount":0,"personTruePositiveAlertsCount":0,"threshold":85},"id":"01ARZ3NDEKTSV4RRFFQ69G5FAV","links":{"self":"https://example.com/follow-lists/01ARZ3NDEKTSV4RRFFQ69G5FAV"},"type":"follow-lists"}},"schema":{"$ref":"#/components/schemas/FullFollowList"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Follow Lists"]},"put":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"putFollowListsByFollow_list_id","parameters":[{"description":"The ID of the Follow List that will be updated.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NewFollowList"}],"example":{"data":{"attributes":{"datasets":["PEP"],"dateOfBirthMatching":"withinThreeYears","frequency":"daily","name":"Follow List - 1","threshold":85},"type":"follow-lists"}}}}},"description":"Follow List payload."},"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":{"attributes":{"countryRequired":false,"datasets":["PEP"],"dateOfBirthMatching":"withinThreeYears","dateOfBirthRequired":false,"frequency":"daily","matching":"fuzzy","name":"Follow List - 1","pepTiers":[],"threshold":85},"id":"01ARZ3NDEKTSV4RRFFQ69G5FAV","links":{"self":"https://example.com/follow-lists/01ARZ3NDEKTSV4RRFFQ69G5FAV"},"type":"follow-lists"}},"schema":{"$ref":"#/components/schemas/FollowList"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Follow Lists"]}},"/follow-lists/{follow_list_id}/subscriptions/businesses":{"get":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"getFollowListsSubscriptionsBusinessesByFollow_list_id","parameters":[{"description":"The ID of the Follow List where a Subscription will be created.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"`size`defines the number of records to return in each page. default value: 10, maximum value: 20. <br>`cursor`specifies the next page cursor.","in":"query","name":"page","schema":{"$ref":"#/components/schemas/Page"},"style":"deepObject"},{"description":"Filters Subscriptions by status. If not present, all Subscriptions are returned.","in":"query","name":"status","schema":{"enum":["open","closed"],"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":[{"attributes":{"countries":["US"],"createdDateTimeISO":"2023-05-10T11:24:12.515Z","discardedCount":0,"falsePositiveCount":0,"id":"ABC123","lastUpdatedDateTimeISO":"2023-05-10T14:35:48.019Z","name":"BMI Corporation","openCount":0,"truePositiveCount":0},"id":"01H2TC48NQGJ1RXJBQC3GR72QC","links":{"self":"https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/businesses/01H2TC48NQGJ1RXJBQC3GR72QC"},"type":"subscriptions"}],"links":{"next":"https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/businesses?page[cursor]=eyJnc2kxaGFQ0dHUjdUUVYifQ==&page[size]=1","self":"https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/businesses?page[size]=1"},"meta":{"discardedAlertsCount":0,"falsePositiveAlertsCount":0,"openAlertsCount":0,"openSubscriptionsCount":0,"subscriptionsCount":2,"truePositiveAlertsCount":0}},"schema":{"$ref":"#/components/schemas/ListOfPersonSubscriptions"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Business Subscriptions"]},"post":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"postFollowListsSubscriptionsBusinessesByFollow_list_id","parameters":[{"description":"The ID of the Follow List where a Subscription will be created.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NewBusinessSubscription"}],"example":{"data":{"attributes":{"countries":["US"],"name":"BMI Corporation"},"type":"subscriptions"}}}}},"description":"Subscription payload."},"responses":{"201":{"content":{"application/vnd.api+json":{"example":{"data":{"attributes":{"countries":["US"],"name":"BMI Corporation"},"id":"01ARZ3NDEKTSV4RRFFQ69G5FAV","links":{"self":"https://example.com/follow-lists/93CVS1NDEKTSV4RRFFQ69F2FDC/subscriptions/businesses/01ARZ3NDEKTSV4RRFFQ69G5FAV"},"type":"subscriptions"}},"schema":{"$ref":"#/components/schemas/UpdatedBusinessSubscription"}}},"description":"Created","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Business Subscriptions"]}},"/follow-lists/{follow_list_id}/subscriptions/businesses/{subscription_id}":{"delete":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"deleteFollowListsSubscriptionsBusinessesByFollow_list_idAndSubscription_id","parameters":[{"description":"The ID of the Follow List that the Subscription belongs to.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription that will be deleted.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"responses":{"204":{"description":"No Content","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Business Subscriptions"]},"get":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"getFollowListsSubscriptionsBusinessesByFollow_list_idAndSubscription_id","parameters":[{"description":"The ID of the Follow List that the Subscription belongs to.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription that will be returned.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":{"attributes":{"countries":["US"],"createdDateTimeISO":"2021-10-05T10:10:08.270Z","discardedCount":0,"falsePositiveCount":0,"id":"ABC123","lastUpdatedDateTimeISO":"2021-10-05T10:10:08.270Z","name":"BMI Corporation","openCount":1,"truePositiveCount":0},"id":"01ARZ3NDEKTSV4RRFFQ69G5FAV","links":{"self":"https://example.com/follow-lists/93CVS1NDEKTSV4RRFFQ69F2FDC/subscriptions/businesses/01ARZ3NDEKTSV4RRFFQ69G5FAV"},"type":"subscriptions"}},"schema":{"$ref":"#/components/schemas/FullBusinessSubscription"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Business Subscriptions"]},"put":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"putFollowListsSubscriptionsBusinessesByFollow_list_idAndSubscription_id","parameters":[{"description":"The ID of the Follow List that the Subscription belongs to.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription that will be updated.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NewBusinessSubscription"}],"example":{"data":{"attributes":{"countries":["US"],"name":"BMI Corporation"},"type":"subscriptions"}}}}},"description":"Subscription payload."},"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":{"attributes":{"countries":["US"],"name":"BMI Corporation"},"id":"01ARZ3NDEKTSV4RRFFQ69G5FAV","links":{"self":"https://example.com/follow-lists/93CVS1NDEKTSV4RRFFQ69F2FDC/subscriptions/businesses/01ARZ3NDEKTSV4RRFFQ69G5FAV"},"type":"subscriptions"}},"schema":{"$ref":"#/components/schemas/UpdatedBusinessSubscription"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Business Subscriptions"]}},"/follow-lists/{follow_list_id}/subscriptions/businesses/{subscription_id}/alerts":{"get":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"getFollowListsSubscriptionsBusinessesAlertsByFollow_list_idAndSubscription_id","parameters":[{"description":"The ID of the Follow List where a Subscription will be created.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription that is used to get Alerts. All Alerts are the matching profiles for the given Subscription.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"`size`defines the number of records to return in each page. default value: 10, maximum value: 20. <br>`cursor`specifies the next page cursor.","in":"query","name":"page","schema":{"$ref":"#/components/schemas/Page"},"style":"deepObject"}],"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":[{"attributes":{"businessID":"NQZGEVkxH3pAYV0KQhQTXV0gFFJ9QAFKUXJZWmENWl1SJ2QhBnlBKWYmElp2QFp5f28EURVGFFxTdgBaCABXGWFTVwFUchY=","countries":["US"],"currentStatus":"true-positive","datasets":["RRE","POI"],"match":"BMI Corporation","matchVersion":7,"name":"BMI Corporation","score":100,"version":1673422459727},"id":"NQZGEVkxH3oUZAFaFRA=","links":{"self":"https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/businesses/01H2TC48NQGJ1RXJBQC3GR72QC/alerts/NQZGEVkxH3oUZAFaFRA="},"type":"reviews"}],"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"}},"schema":{"$ref":"#/components/schemas/ListOfBusinessAlerts"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Business Alerts"]}},"/follow-lists/{follow_list_id}/subscriptions/businesses/{subscription_id}/alerts/auto-reviews":{"put":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"putFollowListsSubscriptionsBusinessesAlertsAutoReviewsByFollow_list_idAndSubscription_id","parameters":[{"description":"The ID of the Follow List that the Subscription belongs to.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BatchAlertReviews"}],"example":{"data":[{"attributes":{"matchVersion":6,"monitoringID":"NQZGEVsxH3oUZAFaFRA=","riskComment":"not a risk for the business","riskRating":"not risky","status":"true-positive","userID":"123"},"type":"reviews"}]}}}},"description":"Batch reviews payload."},"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":[{"attributes":{"review":{"matchVersion":2,"monitoringID":"NQZGEVsxH3oUZAFaFRA=","riskComment":"not a risk for the business","riskRating":"not risky","status":"true-positive","userID":"123"},"status":"success"},"type":"reviews"},{"attributes":{"error":{"code":"ERR-01","message":"Resource not found"},"review":{"matchVersion":1,"monitoringID":"NDZGEVsxH3oUZAFsFRA=","riskComment":"not a risk for the business","riskRating":"not risky","status":"false-positive","userID":"123"},"status":"error"},"type":"reviews"}]},"schema":{"$ref":"#/components/schemas/BatchResponse"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Business Alerts"]}},"/follow-lists/{follow_list_id}/subscriptions/businesses/{subscription_id}/alerts/reviews":{"put":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"putFollowListsSubscriptionsBusinessesAlertsReviewsByFollow_list_idAndSubscription_id","parameters":[{"description":"The ID of the Follow List that the Subscription belongs to.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BatchAlertReviews"}],"example":{"data":[{"attributes":{"matchVersion":6,"monitoringID":"NQZGEVkxH3oUZAFaFRA=","riskComment":"not a risk for the business","riskRating":"not risky","status":"true-positive","userID":"123"},"type":"reviews"}]}}}},"description":"Batch reviews payload."},"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":[{"attributes":{"review":{"matchVersion":2,"monitoringID":"NQZGEVsxH3oUZAFaFRA=","riskComment":"not a risk for the business","riskRating":"not risky","status":"true-positive","userID":"123"},"status":"success"},"type":"reviews"},{"attributes":{"error":{"code":"ERR-01","message":"Resource not found"},"review":{"matchVersion":1,"monitoringID":"NDZGEVsxH3oUZAFsFRA=","riskComment":"not a risk for the business","riskRating":"not risky","status":"false-positive","userID":"123"},"status":"error"},"type":"reviews"}]},"schema":{"$ref":"#/components/schemas/BatchResponse"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Business Alerts"]}},"/follow-lists/{follow_list_id}/subscriptions/businesses/{subscription_id}/alerts/{monitoring_id}":{"get":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"getFollowListsSubscriptionsBusinessesAlertsByFollow_list_idAndSubscription_idAndMonitoring_id","parameters":[{"description":"The ID of the Follow List where a Subscription will be created.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription that is used to get an Alert. Alert is a matching profile for the given Subscription.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Alert that contains matching profile.","in":"path","name":"monitoring_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":{"attributes":{"businessID":"NQZGEVkxH3pAYc0KQhqTXV0gFFJ9QAFKUXdZWmENWl1SJ2QhBnlBKWYmElp2QFp5f28EURVGFFxTdgBaCABXGWFTVwFUchY=","countries":["us"],"currentStatus":"true-positive","datasets":["RRE","PEP-LINKED"],"match":"BMI Corporation","matchVersion":7,"name":"BMI Corporation","score":100,"version":1673422459727},"id":"NQZGEVkxH3oUZAFaFRA=","links":{"self":"https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/businesses/01H2TC48NQGJ1RXJBQC3GR72QC/alerts/NQZGEVkxH3oUZAFaFRA="},"type":"alerts"}},"schema":{"$ref":"#/components/schemas/FullBusinessAlert"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Business Alerts"]}},"/follow-lists/{follow_list_id}/subscriptions/businesses/{subscription_id}/alerts/{monitoring_id}/reviews":{"get":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"getFollowListsSubscriptionsBusinessesAlertsReviewsByFollow_list_idAndSubscription_idAndMonitoring_id","parameters":[{"description":"The ID of the Follow List that the Subscription belongs to.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription that will be returned.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Alert that contains matching profile.","in":"path","name":"monitoring_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"`size`defines the number of records to return in each page. default value: 10, maximum value: 20. <br>`cursor`specifies the next page cursor.","in":"query","name":"page","schema":{"$ref":"#/components/schemas/Page"},"style":"deepObject"},{"description":"Defines the order of the data returned. Use desc to sort in descending order or asc to sort in ascending order. Defaults to asc if not provided.","example":"desc","in":"query","name":"order","schema":{"enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":[{"attributes":{"dateTimeISO":"2023-06-13T18:09:37.748Z","status":"open"},"type":"reviews"},{"attributes":{"dateTimeISO":"2023-06-19T15:24:02.333Z","riskComment":"very risky","riskRating":"risky","status":"true-positive","userID":"123"},"type":"reviews"}],"links":{"next":"https://example.com/follow-lists/01H2T8GTATYBFDSE99N7QZ9KK8/subscriptions/persons/01H2TC48NQGJ1RXJBQCGGR7TQV/alerts/NQZGEVkxH3oUZAFaFRA=/reviews?page[cursor]=eyJzb3J0S2V5IjoiTUhTVC0xMTI5MdM1lVYwMDAwMDIiLCJwYXJ0aXRpb25LZXkiOiJNVC01NjlfVEVTVC0wMUgyVDhHVEFUWUJGRFNFOTlON1FaOUtLOC0wMUgyVEM0OE5RR0oxUlhKQlFDR0dSN1RRViJ9","self":"https://example.com/follow-lists/01H2T8GTATYBFDSE99N7QZ9KK8/subscriptions/persons/01H2TC48NQGJ1RXJBQCGGR7TQV/alerts/NQZGEVkxH3oUZAFaFRA=/reviews"}},"schema":{"$ref":"#/components/schemas/ListOfAlertReviews"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Business Alerts"]}},"/follow-lists/{follow_list_id}/subscriptions/persons":{"get":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"getFollowListsSubscriptionsPersonsByFollow_list_id","parameters":[{"description":"The ID of the Follow List where a Subscription will be created.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"`size`defines the number of records to return in each page. default value: 10, maximum value: 20. <br>`cursor`specifies the next page cursor.","in":"query","name":"page","schema":{"$ref":"#/components/schemas/Page"},"style":"deepObject"},{"description":"Filters Subscriptions by status. If not present, all Subscriptions are returned.","in":"query","name":"status","schema":{"enum":["open","closed"],"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":[{"attributes":{"countries":["US"],"createdDateTimeISO":"2023-05-10T11:24:12.515Z","dateOfBirth":"1957-06-29","discardedCount":0,"falsePositiveCount":0,"gender":"female","lastUpdatedDateTimeISO":"2023-05-10T14:35:48.019Z","name":"Jane Doe","openCount":0,"truePositiveCount":0},"id":"01H2TC48NQGJ1RXJBQC3GR72QC","links":{"self":"https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/persons/01H2TC48NQGJ1RXJBQC3GR72QC"},"type":"subscriptions"}],"links":{"next":"https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/persons?page[cursor]=eyJnc2kxaGFQ0dHUjdUUVYifQ==&page[size]=1","self":"https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/persons?page[size]=1"},"meta":{"discardedAlertsCount":0,"falsePositiveAlertsCount":0,"openAlertsCount":0,"openSubscriptionsCount":0,"subscriptionsCount":2,"truePositiveAlertsCount":0}},"schema":{"$ref":"#/components/schemas/ListOfPersonSubscriptions"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Persons Subscriptions"]},"post":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"postFollowListsSubscriptionsPersonsByFollow_list_id","parameters":[{"description":"The ID of the Follow List where a Subscription will be created.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NewPersonSubscription"}],"example":{"data":{"attributes":{"countries":["US"],"dateOfBirth":"1991-07-22","gender":"female","name":"Jane Doe"},"type":"subscriptions"}}}}},"description":"Subscription payload."},"responses":{"201":{"content":{"application/vnd.api+json":{"example":{"data":{"attributes":{"countries":["US"],"dateOfBirth":"1991-07-22","gender":"female","name":"Jane Doe"},"id":"01ARZ3NDEKTSV4RRFFQ69G5FAV","links":{"self":"https://example.com/follow-lists/93CVS1NDEKTSV4RRFFQ69F2FDC/subscriptions/persons/01ARZ3NDEKTSV4RRFFQ69G5FAV"},"type":"subscriptions"}},"schema":{"$ref":"#/components/schemas/UpdatedPersonSubscription"}}},"description":"Created","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Persons Subscriptions"]}},"/follow-lists/{follow_list_id}/subscriptions/persons/{subscription_id}":{"delete":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"deleteFollowListsSubscriptionsPersonsByFollow_list_idAndSubscription_id","parameters":[{"description":"The ID of the Follow List that the Subscription belongs to.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription that will be deleted.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"responses":{"204":{"description":"No Content","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Persons Subscriptions"]},"get":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"getFollowListsSubscriptionsPersonsByFollow_list_idAndSubscription_id","parameters":[{"description":"The ID of the Follow List that the Subscription belongs to.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription that will be returned.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":{"attributes":{"countries":["US"],"createdDateTimeISO":"2021-10-05T10:10:08.270Z","dateOfBirth":"1991-07-22","discardedCount":0,"falsePositiveCount":0,"gender":"female","lastUpdatedDateTimeISO":"2021-10-05T10:10:08.270Z","name":"Jane Doe","openCount":1,"truePositiveCount":0},"id":"01ARZ3NDEKTSV4RRFFQ69G5FAV","links":{"self":"https://example.com/follow-lists/93CVS1NDEKTSV4RRFFQ69F2FDC/subscriptions/persons/01ARZ3NDEKTSV4RRFFQ69G5FAV"},"type":"subscriptions"}},"schema":{"$ref":"#/components/schemas/FullPersonSubscription"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Persons Subscriptions"]},"put":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"putFollowListsSubscriptionsPersonsByFollow_list_idAndSubscription_id","parameters":[{"description":"The ID of the Follow List that the Subscription belongs to.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription that will be updated.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NewPersonSubscription"}],"example":{"data":{"attributes":{"countries":["US"],"dateOfBirth":"1991-07-22","gender":"female","name":"Jane Doe"},"type":"subscriptions"}}}}},"description":"Subscription payload."},"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":{"attributes":{"countries":["US"],"dateOfBirth":"1991-07-22","gender":"female","name":"Jane Doe"},"id":"01ARZ3NDEKTSV4RRFFQ69G5FAV","links":{"self":"https://example.com/follow-lists/93CVS1NDEKTSV4RRFFQ69F2FDC/subscriptions/persons/01ARZ3NDEKTSV4RRFFQ69G5FAV"},"type":"subscriptions"}},"schema":{"$ref":"#/components/schemas/UpdatedPersonSubscription"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Persons Subscriptions"]}},"/follow-lists/{follow_list_id}/subscriptions/persons/{subscription_id}/alerts":{"get":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"getFollowListsSubscriptionsPersonsAlertsByFollow_list_idAndSubscription_id","parameters":[{"description":"The ID of the Follow List where a Subscription will be created.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription that is used to get Alerts. All Alerts are the matching profiles for the given Subscription.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"`size`defines the number of records to return in each page. default value: 10, maximum value: 20. <br>`cursor`specifies the next page cursor.","in":"query","name":"page","schema":{"$ref":"#/components/schemas/Page"},"style":"deepObject"}],"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":[{"attributes":{"countries":["tm"],"currentStatus":"true-positive","datasets":["RRE","PEP-FORMER"],"datesOfBirth":["1957-06-29"],"gender":"male","match":"Jane Doe","matchVersion":7,"name":"Jane Marie Doe","pepTier":"PEP Tier 1","personID":"NQZGEVkxH3pAYV0KQhQTXV0gFFJ9QAFKUXJZWmENWl1SJ2QhBnlBKWYmElp2QFp5f28EURVGFFxTdgBaCABXGWFTVwFUchY=","profileImage":"https://www.acurisriskintelligence.com/cdn/content/0020615000/0020612599.jpg","score":100,"version":1673422459727},"id":"NQZGEVkxH3oUZAFaFRA=","links":{"self":"https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/persons/01H2TC48NQGJ1RXJBQC3GR72QC/alerts/NQZGEVkxH3oUZAFaFRA="},"type":"reviews"}],"links":{"next":"https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/persons/alerts?page[cursor]=eyJnc2kxaGFQ0dHUjdUUVYifQ==&page[size]=1","self":"https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/persons/alerts?page[size]=1"}},"schema":{"$ref":"#/components/schemas/ListOfPersonAlerts"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Persons Alerts"]}},"/follow-lists/{follow_list_id}/subscriptions/persons/{subscription_id}/alerts/auto-reviews":{"put":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"putFollowListsSubscriptionsPersonsAlertsAutoReviewsByFollow_list_idAndSubscription_id","parameters":[{"description":"The ID of the Follow List that the Subscription belongs to.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BatchAlertReviews"}],"example":{"data":[{"attributes":{"matchVersion":6,"monitoringID":"NQZGEVsxH3oUZAFaFRA=","riskComment":"not a risk for the business","riskRating":"not risky","status":"true-positive","userID":"123"},"type":"reviews"}]}}}},"description":"Batch reviews payload."},"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":[{"attributes":{"review":{"matchVersion":2,"monitoringID":"NQZGEVsxH3oUZAFaFRA=","riskComment":"not a risk for the business","riskRating":"not risky","status":"true-positive","userID":"123"},"status":"success"},"type":"reviews"},{"attributes":{"error":{"code":"ERR-01","message":"Resource not found"},"review":{"matchVersion":1,"monitoringID":"NDZGEVsxH3oUZAFsFRA=","riskComment":"not a risk for the business","riskRating":"not risky","status":"false-positive","userID":"123"},"status":"error"},"type":"reviews"}]},"schema":{"$ref":"#/components/schemas/BatchResponse"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Persons Alerts"]}},"/follow-lists/{follow_list_id}/subscriptions/persons/{subscription_id}/alerts/reviews":{"put":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"putFollowListsSubscriptionsPersonsAlertsReviewsByFollow_list_idAndSubscription_id","parameters":[{"description":"The ID of the Follow List that the Subscription belongs to.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BatchAlertReviews"}],"example":{"data":[{"attributes":{"matchVersion":6,"monitoringID":"NQZGEVsxH3oUZAFaFRA=","riskComment":"not a risk for the business","riskRating":"not risky","status":"true-positive","userID":"123"},"type":"reviews"}]}}}},"description":"Batch reviews payload."},"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":[{"attributes":{"review":{"matchVersion":2,"monitoringID":"NQZGEVsxH3oUZAFaFRA=","riskComment":"not a risk for the business","riskRating":"not risky","status":"true-positive","userID":"123"},"status":"success"},"type":"reviews"},{"attributes":{"error":{"code":"ERR-01","message":"Resource not found"},"review":{"matchVersion":1,"monitoringID":"NDZGEVsxH3oUZAFsFRA=","riskComment":"not a risk for the business","riskRating":"not risky","status":"false-positive","userID":"123"},"status":"error"},"type":"reviews"}]},"schema":{"$ref":"#/components/schemas/BatchResponse"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Persons Alerts"]}},"/follow-lists/{follow_list_id}/subscriptions/persons/{subscription_id}/alerts/{monitoring_id}":{"get":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"getFollowListsSubscriptionsPersonsAlertsByFollow_list_idAndSubscription_idAndMonitoring_id","parameters":[{"description":"The ID of the Follow List where a Subscription will be created.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription that is used to get an Alert. Alert is a matching profile for the given Subscription.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Alert that contains matching profile.","in":"path","name":"monitoring_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":{"attributes":{"countries":["us"],"currentStatus":"true-positive","datasets":["RRE","PEP-FORMER"],"datesOfBirth":["1957-06-29"],"gender":"male","match":"Jane Doe","matchVersion":7,"name":"Jane Marie Doe","pepTier":"PEP Tier 1","personID":"NQZGEVkxH3pAYc0KQhqTXV0gFFJ9QAFKUXdZWmENWl1SJ2QhBnlBKWYmElp2QFp5f28EURVGFFxTdgBaCABXGWFTVwFUchY=","profileImage":"https://www.acurisriskintelligence.com/cdn/content/0020615000/0020612599.jpg","score":100,"version":1673422459727},"id":"NQZGEVkxH3oUZAFaFRA=","links":{"self":"https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/persons/01H2TC48NQGJ1RXJBQC3GR72QC/alerts/NQZGEVkxH3oUZAFaFRA="},"type":"alerts"}},"schema":{"$ref":"#/components/schemas/FullPersonAlert"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Persons Alerts"]}},"/follow-lists/{follow_list_id}/subscriptions/persons/{subscription_id}/alerts/{monitoring_id}/reviews":{"get":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/compliance-monitoring)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"getFollowListsSubscriptionsPersonsAlertsReviewsByFollow_list_idAndSubscription_idAndMonitoring_id","parameters":[{"description":"The ID of the Follow List that the Subscription belongs to.","in":"path","name":"follow_list_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Subscription that will be returned.","in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"The ID of the Alert that contains matching profile.","in":"path","name":"monitoring_id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"description":"`size`defines the number of records to return in each page. default value: 10, maximum value: 20. <br>`cursor`specifies the next page cursor.","in":"query","name":"page","schema":{"$ref":"#/components/schemas/Page"},"style":"deepObject"},{"description":"Defines the order of the data returned. Use desc to sort in descending order or asc to sort in ascending order. Defaults to asc if not provided.","example":"desc","in":"query","name":"order","schema":{"enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"example":{"data":[{"attributes":{"dateTimeISO":"2023-06-13T18:09:37.748Z","status":"open"},"type":"reviews"},{"attributes":{"dateTimeISO":"2023-06-19T15:24:02.333Z","riskComment":"very risky","riskRating":"risky","status":"true-positive","userID":"123"},"type":"reviews"}],"links":{"next":"https://example.com/follow-lists/01H2T8GTATYBFDSE99N7QZ9KK8/subscriptions/persons/01H2TC48NQGJ1RXJBQCGGR7TQV/alerts/NQZGEVkxH3oUZAFaFRA=/reviews?page[cursor]=eyJzb3J0S2V5IjoiTUhTVC0xMTI5MdM1lVYwMDAwMDIiLCJwYXJ0aXRpb25LZXkiOiJNVC01NjlfVEVTVC0wMUgyVDhHVEFUWUJGRFNFOTlON1FaOUtLOC0wMUgyVEM0OE5RR0oxUlhKQlFDR0dSN1RRViJ9","self":"https://example.com/follow-lists/01H2T8GTATYBFDSE99N7QZ9KK8/subscriptions/persons/01H2TC48NQGJ1RXJBQCGGR7TQV/alerts/NQZGEVkxH3oUZAFaFRA=/reviews"}},"schema":{"$ref":"#/components/schemas/ListOfAlertReviews"}}},"description":"OK","headers":{"X-Correlation-Id":{"schema":{"description":"Unique request identifier","format":"uuid","type":"string"}},"X-Ratelimit-Limit":{"schema":{"description":"The number of request available in a rate limit window","type":"integer"}},"X-Ratelimit-Remaining":{"schema":{"description":"The number of requests left for the rate limit window","type":"integer"}},"X-Ratelimit-Reset":{"schema":{"description":"The Unix timestamp at which the current rate limit window resets","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"tags":["Persons Alerts"]}}},"security":[{"ApiKeyAuth":[]}],"servers":[{"url":"https://api.company.info/compliance/monitor/v2"}],"x-readme":{"proxy-enabled":false}}