{"components":{"parameters":{"EvidenceID":{"description":"The ID of the evidence within the profile.","in":"path","name":"evidenceID","required":true,"schema":{"$ref":"#/components/schemas/EvidenceID"}}},"responses":{"BadRequest":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Bad Request"},"EvidencePDF":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK","headers":{"Content-Length":{"schema":{"description":"The size of the PDF in bytes. Absent when the size is not known up front, in which case the response is chunked.","type":"integer"}},"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"}}}},"Forbidden":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Forbidden"},"GatewayTimeout":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"The provider did not respond in time."},"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":{"BusinessAddressSchema":{"properties":{"addressType":{"description":"Indicated the type of address.","enum":["Registered","Operating","Previous","Branch Office","Representative Office","Headquarters"],"type":"string"},"city":{"description":"The city of the address.","example":"Katowice","type":"string"},"countryISOCode":{"description":"The ISO country code of the address.","example":"PL","type":"string"},"county":{"description":"The county of the address.","example":"Countyville","type":"string"},"countyAbbreviation":{"description":"The abreviation of the country if appropriate.","example":"CVL","type":"string"},"line1":{"description":"The first line of the address.","example":"17 Cobble Drive","type":"string"},"line2":{"description":"The second line of the address.","example":"Manhattan","type":"string"},"postcode":{"description":"The postcode of the address.","example":"RE11 66G","type":"string"}},"required":["addressType","countryISOCode"],"type":"object"},"BusinessDataObject":{"description":"an business object structure","properties":{"attributes":{"properties":{"countries":{"description":"The list of countries from the addresses and nationalities of the profile.","example":["US"],"items":{"type":"string"},"type":"array"},"datasets":{"description":"The profile datasets\n * PEP - (Deprecated - ignore)\n * PEP-LINKED - Only linked PEPs (PEP by Association)\n * SAN - (Deprecated - ignore)\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 - (Deprecated - ignore)\n * SOE-CURRENT - Only current SOE\n * SOE-FORMER - Only former SOE.\n","example":["SAN-CURRENT"],"items":{"enum":["PEP","PEP-LINKED","SAN","SAN-CURRENT","SAN-FORMER","INS","RRE","REL","POI","SOE-CURRENT","SOE-FORMER"],"type":"string"},"minItems":1,"type":"array"},"match":{"description":"The name of the profile that has been matched in the search.","example":"IBM Corp","type":"string"},"monitoringID":{"$ref":"#/components/schemas/MonitoringID"},"name":{"description":"The primary name of the profile.","example":"IBM 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 been changed.","example":15346444345,"type":"integer"}},"required":["datasets","id","score","match","name","countries"],"type":"object"},"id":{"$ref":"#/components/schemas/ID"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"type":{"type":"string"}},"title":"business object","type":"object"},"BusinessEvidenceSchema":{"allOf":[{"properties":{"datasets":{"description":"The evidence datasets\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 (not available for Search endpoint)\n * ID - Identity\n * CORP - Corporate/Business (not available for Search endpoint)\n * PEP-CURRENT - (Deprecated - ignore).\n","example":["SOE-CURRENT","RRE"],"items":{"enum":["SAN-CURRENT","SAN-FORMER","INS","RRE","POI","REL","SOE-CURRENT","SOE-FORMER","GRI","ID","CORP","PEP-CURRENT"],"type":"string"},"minItems":1,"type":"array"}},"required":["datasets"],"type":"object"},{"$ref":"#/components/schemas/EvidenceSchema"}]},"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 (not available for Search endpoint)\n","example":["INS","PEP-LINKED","POI","REL","RRE","SAN-CURRENT","SAN-FORMER","SOE-CURRENT","GRI"],"items":{"enum":["PEP-LINKED","SAN-CURRENT","SAN-FORMER","INS","RRE","POI","REL","SOE-CURRENT","SOE-FORMER","GRI"],"type":"string"},"minItems":1,"type":"array"},"BusinessesList":{"description":"list of businesses","properties":{"data":{"items":{"$ref":"#/components/schemas/BusinessDataObject"},"type":"array"},"links":{"properties":{"first":{"$ref":"#/components/schemas/JSONAPILink"},"last":{"$ref":"#/components/schemas/JSONAPILink"},"next":{"$ref":"#/components/schemas/JSONAPILink"},"prev":{"$ref":"#/components/schemas/JSONAPILink"},"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"meta":{"properties":{"totalPages":{"type":"integer"},"totalResults":{"type":"integer"}},"type":"object"}},"title":"businesses search response","type":"object"},"BusinessesSearchMatch":{"properties":{"countries":{"description":"Coma separated strings. Two-letter country code ISO-3166-2.","example":"NL,GB","type":"string"},"countryRequired":{"default":false,"description":"Tells if profiles with unknown country and no nationality should be filtered out of the search results when searching for a person or a business from a specified country. If 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. If set to true, and country is specified, profiles with no country and no nationality will NOT appear in the results. If the country is not specified in the search, the attribute is ignored (profiles with no country and no nationality will appear in search results with no penalty).","example":true,"type":"boolean"},"datasets":{"description":"Coma separated strings. Specifies which datasets will be searched.\n  * PEP - Politically Exposed Persons (All)\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  * POI - Profile Of Interest\n  * REL - Regulatory Enforcement List.\n  * SOE - State Owned Enterprises (All)\n  * SOE-CURRENT - Only current SOE\n  * SOE-FORMER - Only former SOE.\n","example":"PEP,SOE","type":"string"},"matching":{"default":"fuzzy","description":"Defines what name matching algorithm is used for profile search. The Fuzzy algorithm is the default and applies all of our fuzzy matching techniques to ensure the most accurate results. The Strict algorithm uses some fuzzy matching, but is more restrictive in its approach and may miss some matches if the exact name is not known. We strongly recommend using the Fuzzy algorithm for the best results and only using the Strict algorithm to reduce the number of matches to the bare minimum, when the exact name is known.","enum":["fuzzy","strict"],"example":"fuzzy","type":"string"},"name":{"example":"Company.Info","type":"string"},"threshold":{"default":85,"example":90,"maximum":100,"minimum":75,"type":"integer"}},"required":["name","datasets"],"title":"Businesses Search Match","type":"object"},"ContactEntriesBusinessSchema":{"properties":{"category":{"enum":["Telephone","Fax","Website"],"example":"Website","type":"string"},"value":{"example":"https://www.example.com","type":"string"}},"required":["category","value"],"type":"object"},"DdSchema":{"properties":{"caseReference":{"description":"The unique Companies House ID number of the disqualification.","example":"INV5943477","type":"string"},"conduct":{"description":"The name of the company that the person was acting for.","example":"Brufix Glazing System Installations Limited","type":"string"},"dateFromISO":{"description":"Start date of the disqualification.","example":"2021-03-09","type":"string"},"dateToISO":{"description":"End date of the disqualificaiton.","example":"2027-03-08","type":"string"},"evidenceIDs":{"description":"The list of supporting evidence.","items":{"$ref":"#/components/schemas/EvidenceID"},"type":"array"},"reason":{"description":"The reason for the disqualification.","example":"Disqualification order or undertaking; and reporting provisions.","type":"string"}},"required":["reason","evidenceIDs"],"type":"object"},"EvidenceID":{"description":"Identifies one item in a profile's `evidences` list. Use it to retrieve the PDF of that evidence.","example":"23729390","title":"ID of a piece of evidence within a person or business profile.","type":"string"},"EvidenceSchema":{"properties":{"assetURL":{"description":"The URL link to the PDF version of the evidence. This is only available for non-copyright sources.","type":"string"},"captureDateISO":{"description":"The ISO date that the evidence was captured into the system.","example":"2020-01-12","type":"string"},"credibility":{"enum":["Low","Medium","High"],"example":"Medium","type":"string"},"evidenceID":{"$ref":"#/components/schemas/EvidenceID"},"isCopyrighted":{"default":false,"description":"This indicates whether or not the evidence is protected under copyright laws.","example":true,"type":"boolean"},"keywords":{"description":"Key words associated with the evidence.","example":"Money Laundering, AML","type":"string"},"language":{"description":"The ISO 639-3 code for the language of the evidence.","example":"eng","type":"string"},"originalURL":{"description":"A link to the original public source of the evidence, and the first place to read it. Sources may become unavailable over time; when the evidence can no longer be read here, use `assetURL` if it is set, or the copyrighted evidence endpoint.","example":"https://www.example.com","type":"string"},"publicationDateISO":{"description":"The ISO date that the evidence was originally published.","example":"2020-01-11","type":"string"},"summary":{"description":"For copyrighted evidence, a text snippet from the evidence will be provided.","type":"string"},"title":{"description":"The title captured from the article.","example":"Example Arrested for Money Laundering","type":"string"}},"required":["evidenceID","originalURL","captureDateISO","isCopyrighted"],"type":"object"},"FullBusinessDataObject":{"description":"an business object structure","properties":{"attributes":{"properties":{"activities":{"description":"The list of business activities.","example":["Securities broker","Electric car manufacturer"],"items":{"type":"string"},"type":"array"},"addresses":{"items":{"allOf":[{"$ref":"#/components/schemas/BusinessAddressSchema"}]},"minItems":1,"type":"array"},"aliases":{"description":"Defines a list of aliases for the business.","items":{"properties":{"alias":{"example":"Govprom","type":"string"},"type":{"description":"This field indicates the type of the alias.","enum":["Original Script Name","Name Spelling Variation","Name Abbreviation","Previous Name","Brand Name","Fake Name"],"example":"Original Script Name","type":"string"}},"required":["type","alias"],"type":"object"},"type":"array"},"businessLinks":{"items":{"allOf":[{"$ref":"#/components/schemas/LinkedBusinessSchema"}]},"type":"array"},"businessTypes":{"description":"Indicated the type of business profile.","example":["Bank"],"items":{"enum":["Vessel","Aircraft","Terrorist Organisation","Organised Crime Group","Militant Group","Shell Corporation","Sovereign Wealth Fund","Government Body","Political Party","Civic Movement","International Organisation","Other International Organisations","Non-Government Organisation","Charitable Organisation","Professional Organisation","Privately-Held Company","Publicly-Traded Company","Trust Fund","Bank","Cryptocurrency Business","Gaming Business","Non-Bank Financial Institution","Designated Professional (Gatekeeper) Organisation","Website","Fake Entity/Clone Company","Apps/Applications"],"type":"string"},"type":"array"},"contactEntries":{"items":{"allOf":[{"$ref":"#/components/schemas/ContactEntriesBusinessSchema"}]},"type":"array"},"datasets":{"allOf":[{"$ref":"#/components/schemas/BusinessProfileDatasetsSchema"}]},"deletionReason":{"properties":{"otherReason":{"description":"This value is populated when the reason enum is \"Other\".","example":"Should not have been there in the first place.","type":"string"},"reason":{"description":"The reason for the profile to be deleted.","enum":["Government position out of scope","Adverse media category (RRE/FR/LE/Sanction) out of scope","Duplicate profile","Redundant profile","Expired risk relevance","Other"],"example":"Duplicate profile","type":"string"}},"required":["reason"],"type":"object"},"description":{"description":"Additional information related to the nature of the business.","example":"Fake Representative cold calling.","type":"string"},"evidences":{"items":{"allOf":[{"$ref":"#/components/schemas/BusinessEvidenceSchema"}]},"minItems":1,"type":"array"},"griEntries":{"items":{"allOf":[{"$ref":"#/components/schemas/GriSchema"}]},"type":"array"},"identifiers":{"items":{"properties":{"category":{"example":"VAT/Tax Number","type":"string"},"value":{"example":"463336244428","type":"string"}},"required":["category","value"],"type":"object"},"type":"array"},"individualLinks":{"items":{"allOf":[{"$ref":"#/components/schemas/LinkedIndividualSchema"}]},"type":"array"},"insEntries":{"items":{"allOf":[{"$ref":"#/components/schemas/InsSchema"}]},"type":"array"},"isDeleted":{"default":false,"description":"A true value indicates that the Business has been deleted.","example":false,"type":"boolean"},"monitoringID":{"$ref":"#/components/schemas/MonitoringID"},"name":{"description":"The full name of the Business profile.","example":"Govprom Ltd","type":"string"},"notes":{"items":{"allOf":[{"$ref":"#/components/schemas/NotesSchema"}]},"type":"array"},"poiEntries":{"items":{"allOf":[{"$ref":"#/components/schemas/PoiSchema"}]},"type":"array"},"profileImages":{"description":"Contains a list of URLs to profiles images for the Business.","items":{"type":"string"},"type":"array"},"relEntries":{"items":{"allOf":[{"$ref":"#/components/schemas/RelSchema"}]},"type":"array"},"rreEntries":{"items":{"allOf":[{"$ref":"#/components/schemas/RreSchema"}]},"type":"array"},"sanEntries":{"properties":{"current":{"items":{"allOf":[{"$ref":"#/components/schemas/SanctionSchema"}]},"type":"array"},"former":{"items":{"allOf":[{"$ref":"#/components/schemas/SanctionSchema"}]},"type":"array"}},"required":["current","former"],"type":"object"},"soeEntry":{"allOf":[{"$ref":"#/components/schemas/SoeSchema"}]},"version":{"description":"The version number can be used to detect when a profile has changed.","example":15346444345,"type":"integer"}},"required":["version","notes","name","isDeleted","aliases","businessTypes","activities","provider","addresses","sanEntries","contactEntries","relEntries","rreEntries","poiEntries","insEntries","identifiers","individualLinks","businessLinks","evidences","griEntries","profileImages","datasets","monitoringID"],"type":"object"},"id":{"$ref":"#/components/schemas/ID"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"type":{"type":"string"}},"title":"business object","type":"object"},"FullBusinessObject":{"description":"business full profile","properties":{"data":{"$ref":"#/components/schemas/FullBusinessDataObject"}},"title":"business profile","type":"object"},"FullPersonDataObject":{"description":"an person object structure","properties":{"attributes":{"properties":{"addresses":{"description":"The list of the person's addresses.","items":{"allOf":[{"$ref":"#/components/schemas/IndividualAddressSchema"}]},"minItems":1,"type":"array"},"aliases":{"description":"Defines a list of aliases for the person.","items":{"properties":{"firstName":{"example":"Doe","type":"string"},"lastName":{"example":"John","type":"string"},"middleName":{"type":"string"},"type":{"description":"This field indicates the type of the alias.","enum":["Original Script Name","Name Spelling Variation","Shortened Name","Maiden Name","Nickname","Previous Name","Fake Name"],"example":"Name Spelling Variation","type":"string"}},"required":["type"],"type":"object"},"type":"array"},"businessLinks":{"items":{"allOf":[{"$ref":"#/components/schemas/LinkedBusinessSchema"},{"properties":{"individualLinks":{"description":"The list of persons that are linked to this business.","items":{"allOf":[{"$ref":"#/components/schemas/LinkedIndividualSchema"}]},"type":"array"}},"type":"object"}]},"type":"array"},"contactEntries":{"items":{"properties":{"category":{"enum":["Telephone","Fax","Mobile","Email"],"example":"Email","type":"string"},"value":{"example":"testemail@example.com","type":"string"}},"required":["category","value"],"type":"object"},"type":"array"},"datasets":{"allOf":[{"$ref":"#/components/schemas/IndividualProfileDatasetsSchema"}]},"datesOfBirthISO":{"description":"The list of birth dates for the person.","example":["1959-06-13","1960"],"items":{"description":"Date in either YYYY or YYYY-MM or YYYY-MM-DD ISO format.","example":"1959-06-13","type":"string"},"type":"array"},"datesOfDeathISO":{"description":"The list of death dates for the person.","example":["1959"],"items":{"description":"Date in either YYYY or YYYY-MM or YYYY-MM-DD ISO format.","example":"1959-06-13","type":"string"},"type":"array"},"ddEntries":{"items":{"allOf":[{"$ref":"#/components/schemas/DdSchema"}]},"type":"array"},"deletionReason":{"properties":{"otherReason":{"description":"This value is populated when the reason enum is \"Other\".","example":"Should not have been there in the first place.","type":"string"},"reason":{"description":"The reason for the profile to be deleted.","enum":["Government position out of scope","Adverse media category (RRE/FR/LE/Sanction) out of scope","Duplicate profile","Redundant profile","Expired risk relevance","Other"],"example":"Duplicate profile","type":"string"}},"required":["reason"],"type":"object"},"evidences":{"items":{"allOf":[{"$ref":"#/components/schemas/IndividualEvidenceSchema"}]},"minItems":1,"type":"array"},"firstName":{"description":"The first name of the person.","example":"John","type":"string"},"gender":{"description":"The gender of the person.","enum":["Male","Female"],"type":"string"},"griEntries":{"items":{"allOf":[{"$ref":"#/components/schemas/GriSchema"}]},"type":"array"},"identifiers":{"items":{"properties":{"category":{"example":"NPI Number","type":"string"},"value":{"example":"46333","type":"string"}},"required":["category","value"],"type":"object"},"type":"array"},"individualLinks":{"items":{"allOf":[{"$ref":"#/components/schemas/LinkedIndividualSchema"}]},"type":"array"},"insEntries":{"items":{"allOf":[{"$ref":"#/components/schemas/InsSchema"}]},"type":"array"},"isDeceased":{"default":false,"description":"A true value indicates that the person is deceased.","example":false,"type":"boolean"},"isDeleted":{"default":false,"description":"A true value indicates that the person has been deleted.","example":false,"type":"boolean"},"lastName":{"description":"The last name of the person.","example":"Doe","type":"string"},"middleName":{"description":"The middle name of the person.","example":"Christofer","type":"string"},"monitoringID":{"$ref":"#/components/schemas/MonitoringID"},"nationalitiesISOCodes":{"description":"List of the person's nationalities.","example":["US","NL"],"items":{"description":"ISO country codes.","example":"BG","type":"string"},"type":"array"},"notes":{"items":{"allOf":[{"$ref":"#/components/schemas/NotesSchema"}]},"type":"array"},"pepByAssociationEntries":{"items":{"allOf":[{"$ref":"#/components/schemas/PepAssociationSchema"}]},"type":"array"},"pepEntries":{"properties":{"current":{"items":{"allOf":[{"$ref":"#/components/schemas/PepSchema"}]},"type":"array"},"former":{"items":{"allOf":[{"$ref":"#/components/schemas/PepSchema"}]},"type":"array"},"pepTier":{"description":"Defines the PEP tier of the person.","enum":["PEP Tier 1","PEP Tier 2","PEP Tier 3","PEP By Assocation"],"example":"PEP Tier 2","type":"string"}},"required":["current","former"],"type":"object"},"poiEntries":{"items":{"allOf":[{"$ref":"#/components/schemas/PoiSchema"}]},"type":"array"},"profileImages":{"description":"Contains a list of URLs to profiles images for the person.","items":{"type":"string"},"type":"array"},"relEntries":{"items":{"allOf":[{"$ref":"#/components/schemas/RelSchema"}]},"type":"array"},"rreEntries":{"items":{"allOf":[{"$ref":"#/components/schemas/RreSchema"}]},"type":"array"},"sanEntries":{"properties":{"current":{"items":{"allOf":[{"$ref":"#/components/schemas/SanctionSchema"}]},"type":"array"},"former":{"items":{"allOf":[{"$ref":"#/components/schemas/SanctionSchema"}]},"type":"array"}},"required":["current","former"],"type":"object"},"version":{"description":"The version number can be used to detect if a profile has been changed.","example":15346444345,"type":"integer"}},"required":["version","lastName","isDeleted","isDeceased","aliases","datesOfBirthISO","datesOfDeathISO","nationalitiesISOCodes","addresses","profileImages","notes","contactEntries","evidences","relEntries","rreEntries","poiEntries","ddEntries","individualLinks","businessLinks","sanEntries","identifiers","pepEntries","pepByAssociationEntries","griEntries","datasets","monitoringID"],"type":"object"},"id":{"$ref":"#/components/schemas/ID"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"type":{"type":"string"}},"title":"person object","type":"object"},"FullPersonObject":{"description":"person full profile","properties":{"data":{"$ref":"#/components/schemas/FullPersonDataObject"}},"title":"person profile","type":"object"},"GriSchema":{"properties":{"evidenceID":{"$ref":"#/components/schemas/EvidenceID"},"keywords":{"description":"Keywords associated with the report.","example":"Source of Wealth","type":"string"},"summary":{"description":"The description of the GRI report.","example":"The source provides in-depth information about the subject based on an Enhanced Due Diligence investigation into the subject's source of wealth, potential political exposure and reputational risk exposure.","type":"string"},"title":{"description":"The title of the GRI report.","example":"EDD Report - Executive Summary Report","type":"string"}},"required":["evidenceID","title","summary","keywords"],"type":"object"},"ID":{"title":"ID of a person or an business. The ID can be used to retrieve the full profile of the person or business.","type":"string"},"IndividualAddressSchema":{"properties":{"addressType":{"description":"Indicates the type of address.","enum":["Place of birth","Residential","Business","Previous Residential","Previous Business"],"example":"Place of birth","type":"string"},"city":{"example":"Amsterdam","type":"string"},"countryISOCode":{"description":"The ISO code of the address country.","example":"NL","type":"string"},"county":{"example":"Netherlands","type":"string"},"countyAbbreviation":{"example":"NL","type":"string"},"line1":{"example":"1 Main Street","type":"string"},"line2":{"example":"Weesperplein","type":"string"},"postcode":{"example":"12221","type":"string"}},"required":["addressType","countryISOCode"],"type":"object"},"IndividualEvidenceSchema":{"allOf":[{"properties":{"datasets":{"description":"The evidence 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 (not available for Search endpoint)\n * ID - Identity\n * CORP - Corporate/Business (not available for Search endpoint)\n","example":["PEP-FORMER","INS"],"items":{"enum":["PEP-CURRENT","PEP-FORMER","PEP-LINKED","SAN-CURRENT","SAN-FORMER","INS","RRE","DD","POI","REL","GRI","ID","CORP"],"type":"string"},"minItems":1,"type":"array"}},"required":["datasets"],"type":"object"},{"$ref":"#/components/schemas/EvidenceSchema"}]},"IndividualProfileDatasetsSchema":{"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 (not available for Search endpoint)\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"},"InsSchema":{"properties":{"accountantInBankruptcyCaseNumber":{"description":"The unique case number provided by the Scotland's insolvency service (Accountant in Bankruptcy).","example":"2020/601289","type":"string"},"awardDateISO":{"description":"The date on which the insolvency awarding institution announces its decision.","example":"2020-10-03","type":"string"},"court":{"description":"The name of the court before which the insolvency case is presented.","example":"Voluntary Liquidation Cases","type":"string"},"debt":{"description":"The amount owned by the insolvent subject.","example":"GBP 5,748","type":"string"},"evidenceIDs":{"description":"The list of the supporting evidence.","example":["252231"],"items":{"$ref":"#/components/schemas/EvidenceID"},"type":"array"},"firstOrderDateISO":{"description":"The date on which the first insolvency order was made.","example":"2020-10-11","type":"string"},"gazetteIssueDateISO":{"description":"The date on which the information was published on the gazette.","example":"2020-10-05","type":"string"},"hearingDateISO":{"description":"The date of the hearing of the insolvency case in court.","example":"2020-10-01","type":"string"},"insolvencyEndDateISO":{"description":"The end date of the insolvency.","example":"2024-10-05","type":"string"},"insolvencyIDNumber":{"description":"The unique insolvency ID number provided by the insolvency institution.","type":"string"},"insolvencyStartDateISO":{"description":"The start date of the insolvency.","example":"2020-10-05","type":"string"},"petitioner":{"description":"The person/company who files the petition.","example":"Commissioners For Hm Revenue And Customs","type":"string"},"presentedDateOfPetitionISO":{"description":"The date on which the petition was presented.","example":"2020-10-01","type":"string"},"solicitor":{"description":"The name of the solicitor who is involved in the insolvency process.","example":"HM Revenue and Customs,, Solicitor's Office & Legal Services, South West Wing, Bush House, Strand, London, WC2B 4RD","type":"string"},"type":{"description":"The type of insolvency.","example":"Individual Voluntary Arrangement","type":"string"}},"required":["type","evidenceIDs"],"type":"object"},"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"},"LinkedBusinessSchema":{"properties":{"datasets":{"allOf":[{"$ref":"#/components/schemas/BusinessProfileDatasetsSchema"}]},"id":{"$ref":"#/components/schemas/ID"},"monitoringID":{"$ref":"#/components/schemas/MonitoringID"},"name":{"description":"The name of the linked business.","example":"John Doe Limited","type":"string"},"ownershipPercentage":{"description":"For certain relationship type related to business ownership this value will indicate the percentage ownership when known.","example":75,"maximum":100,"minimum":1,"type":"integer"},"relationship":{"description":"Text including names used to describe the relationship with the business.","example":"John Doe is a board member of Haribo Limited","type":"string"}},"required":["name","id","relationship","datasets"],"type":"object"},"LinkedIndividualSchema":{"properties":{"datasets":{"allOf":[{"$ref":"#/components/schemas/IndividualProfileDatasetsSchema"}]},"firstName":{"description":"The first name of the person.","example":"Jane","type":"string"},"id":{"$ref":"#/components/schemas/ID"},"lastName":{"description":"The last name of the person.","example":"Doe","type":"string"},"middleName":{"description":"The middle name of the person.","example":"Christopher","type":"string"},"monitoringID":{"$ref":"#/components/schemas/MonitoringID"},"ownershipPercentage":{"description":"For certain relationship type related to business ownership this value will indicate the percentage ownership when known.","example":75,"maximum":100,"minimum":1,"type":"integer"},"relationship":{"description":"Text including names used to describe the relationship with the person.","example":"John Doe is the brother of Jane Doe.","type":"string"}},"required":["lastName","relationship","id","datasets"],"type":"object"},"MonitoringID":{"description":"The monitoringID can be used to add an auto-review to a Subscription in the Monitoring API.\nWhen you add a Subscription to the Follow List, you can provide a list of monitoring IDs of profiles that you want to close automatically. \nThis is great if you have already reviewed the real-time search from the Screening API results and don’t want to re-review the Alerts in the Monitoring API. \nThe Alerts are still created for audit purposes but will automatically be closed.\nEven if the Auto review is created, the Alert will be generated, but it will be automatically closed with an auto-review. \nThink of the Auto-review, as a disposition for the system to review the Alert on your behalf during the initial screening.\n","example":"NQZGH3oUYAtYFw","title":"Monitoring ID of the profile","type":"string"},"NotesSchema":{"properties":{"value":{"example":"A sample note","type":"string"}},"required":["value"],"type":"object"},"Page":{"properties":{"number":{"default":1,"description":"This parameter specifies the page number.","type":"integer"},"size":{"default":10,"description":"The number of records to return in each page.","type":"integer"}},"type":"object"},"PepAssociationSchema":{"properties":{"evidenceIDs":{"description":"The list of supporting evidence.","items":{"$ref":"#/components/schemas/EvidenceID"},"type":"array"},"id":{"$ref":"#/components/schemas/ID"}},"required":["id","evidenceIDs"],"type":"object"},"PepSchema":{"properties":{"countryISOCode":{"description":"The ISO country code of the country where the position is held.","example":"GB","type":"string"},"dateFromISO":{"description":"The start data of the political position in format YYYY or YYYY-MM or YYYY-MM-DD.","example":"2019","type":"string"},"dateToISO":{"description":"The end date of the political position in format YYYY or YYYY-MM or YYYY-MM-DD. This date can be in the future.","example":"2022-01-01","type":"string"},"evidenceIDs":{"description":"The list of evidence linked to the political position.","example":["362233"],"items":{"$ref":"#/components/schemas/EvidenceID"},"type":"array"},"position":{"description":"The exact political position in scope for a particular country.","example":"Prime Minister (Kryeministër) | Council of Ministers (Këshillii Ministrave)","type":"string"},"segment":{"description":"The category of in scope PEP positions for a particular country.","example":"Executive Branch - Head and Members of Government and Deputies","type":"string"}},"required":["countryISOCode","position","evidenceIDs"],"type":"object"},"PersonDataObject":{"description":"an person object structure","properties":{"attributes":{"properties":{"countries":{"description":"The list of countries from the addresses and nationalities of the profile. Two-letter country code ISO-3166-2.","example":["US"],"items":{"type":"string"},"type":"array"},"datasets":{"allOf":[{"$ref":"#/components/schemas/IndividualProfileDatasetsSchema"}]},"datesOfBirth":{"example":["1959","1959-08-22"],"items":{"description":"Date in either YYYY-MM-DD or YYYY-MM or YYYY ISO format.","type":"string"},"type":"array"},"gender":{"description":"Gender, if known.","enum":["Male","Female"],"example":"Male","type":"string"},"match":{"description":"The name of the profile that has been matched in the search.","example":"John Doe","type":"string"},"monitoringID":{"$ref":"#/components/schemas/MonitoringID"},"name":{"description":"The primary name of the profile.","example":"John Doe","type":"string"},"pepTier":{"description":"Defines the PEP tier of the 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"},"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 if a profile has changed.","example":15346444345,"type":"integer"}},"type":"object"},"id":{"$ref":"#/components/schemas/ID"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"type":{"type":"string"}},"title":"person object","type":"object"},"PersonsList":{"description":"list of persons","properties":{"data":{"items":{"$ref":"#/components/schemas/PersonDataObject"},"type":"array"},"links":{"properties":{"first":{"$ref":"#/components/schemas/JSONAPILink"},"last":{"$ref":"#/components/schemas/JSONAPILink"},"next":{"$ref":"#/components/schemas/JSONAPILink"},"prev":{"$ref":"#/components/schemas/JSONAPILink"},"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"meta":{"properties":{"totalPages":{"type":"integer"},"totalResults":{"type":"integer"}},"type":"object"}},"title":"paginated persons search response","type":"object"},"PersonsSearchMatch":{"properties":{"countries":{"description":"Coma separated strings. Affects both address and nationality. Two-letter country code ISO-3166-2.","example":"NL,GB","type":"string"},"countryRequired":{"default":false,"description":"Tells if profiles with unknown country and no nationality should be filtered out of the search results when searching for a person or a business from a specified country. If 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. If set to true, and country is specified, profiles with no country and no nationality will NOT appear in the results. If the country is not specified in the search, the attribute is ignored (profiles with no country and no nationality will appear in search results with no penalty).","example":true,"type":"boolean"},"datasets":{"description":"Coma separated strings. 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","example":"PEP,SAN","type":"string"},"dateOfBirth":{"description":"Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future.","example":"1958-06-13","type":"string"},"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 date of birth should be filtered out of the search results when searching for a person with a specified date of birth. If set to false (default value), and dob is specified, profiles with no date of birth will appear in the results with a small penalty applied due to the lack of dob match. If set to true, and dob is specified, profiles with no date of birth will NOT appear in the results. If the dob is not specified in the search, the attribute is ignored (profiles with no date of birth will appear in search results with no penalty).","example":true,"type":"boolean"},"gender":{"description":"Define the gender of the person you are searching for.","enum":["Male","Female"],"example":"Male","type":"string"},"matching":{"default":"fuzzy","description":"Defines what name matching algorithm is used for profile search. The Fuzzy algorithm is the default and applies all of our fuzzy matching techniques to ensure the most accurate results. The Strict algorithm uses some fuzzy matching, but is more restrictive in its approach and may miss some matches if the exact name is not known. We strongly recommend using the Fuzzy algorithm for the best results and only using the Strict algorithm to reduce the number of matches to the bare minimum, when the exact name is known.","enum":["fuzzy","strict"],"example":"fuzzy","type":"string"},"name":{"description":"Full name of the person to screen. For best results, use at least two names. If the last name is known, use a comma-separated format: `LastName, FirstName MiddleName`.  Words before the comma are treated as the last name. Words after the comma are parsed as first and middle names. If no comma is used (e.g. `FirstName MiddleName LastName`), the system tries all combinations, which may lead to false positives (e.g. matching `Adams` when searching for `Adam`) with slightly lower match scores. Using the comma format improves accuracy and reduces ambiguity.","example":"Doe, John","type":"string"},"pepTiers":{"description":"Coma separated strings. When searching 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 searched datasets, then this value is ignored. The PEP Tier filter does not apply to PEP-LINKED Profiles.","enum":["PEP Tier 1","PEP Tier 2","PEP Tier 3"],"example":"PEP Tier 1","type":"string"},"threshold":{"default":85,"example":90,"maximum":100,"minimum":75,"type":"integer"}},"required":["name","datasets"],"title":"Persons Search Match","type":"object"},"PoiSchema":{"properties":{"category":{"description":"The category of the Profile of Interest.","example":"Local Government Administration","type":"string"},"evidenceIDs":{"description":"The list of evidence associated with the POI entry.","example":["542622"],"items":{"$ref":"#/components/schemas/EvidenceID"},"type":"array"},"positions":{"description":"Some POI categories can include positions.","items":{"properties":{"countryISOCode":{"example":"ES","type":"string"},"dateFromISO":{"example":"2021-03-12","type":"string"},"dateOfElectionISO":{"deprecated":true,"description":"use dateFromISO instead","example":"2021-03-12","type":"string"},"dateToISO":{"example":"2021-03-12","type":"string"},"position":{"example":"The name of the political position.","type":"string"},"segment":{"example":"Segment","type":"string"}},"required":["position"],"type":"object"},"type":"array"}},"required":["category","evidenceIDs","positions"],"type":"object"},"RelSchema":{"properties":{"category":{"enum":["Financial Regulator","Law Enforcement"],"example":"Law Enforcement","type":"string"},"events":{"items":{"properties":{"amount":{"description":"For specific event types, there can be associated financial penalties. This field indicates the monetary amount.","example":1000,"type":"integer"},"currencyCode":{"description":"For specific event types, there can be associated financial penalties. This field indicates the international currency code.","example":"USD","type":"string"},"dateISO":{"description":"The ISO date of the event.","example":"2021-04-09","type":"string"},"evidenceIDs":{"description":"The list of evidence associated with the REL event.","example":["354363"],"items":{"$ref":"#/components/schemas/EvidenceID"},"type":"array"},"period":{"description":"Indicates the length of time of the penalty.","properties":{"days":{"type":"integer"},"months":{"type":"integer"},"years":{"type":"integer"}},"type":"object"},"type":{"description":"The type of event associated with the list entry.","example":"Arrest","type":"string"}},"required":["type","evidenceIDs"],"type":"object"},"type":"array"},"subcategory":{"description":"The name of the list.","example":"Police - Avon and Somerset Police - Wanted & In Court - United Kingdom","type":"string"}},"required":["category","subcategory","events"],"type":"object"},"RreSchema":{"properties":{"category":{"example":"Law Enforcement","type":"string"},"events":{"description":"The list of events associated with the RRE entry.","items":{"properties":{"dateISO":{"description":"The ISO date associated with the event.","example":"2021-04-09","type":"string"},"evidenceIDs":{"description":"The list of evidence associated with the RRE event.","example":["354363"],"items":{"$ref":"#/components/schemas/EvidenceID"},"type":"array"},"type":{"description":"The type of event associated with the list entry.","example":"Court Proceedings in Progress: Remand","type":"string"}},"required":["type","evidenceIDs"],"type":"object"},"type":"array"},"subcategory":{"example":"Identity Theft","type":"string"}},"required":["category","subcategory","events"],"type":"object"},"SanctionSchema":{"properties":{"events":{"description":"The list of events associated with the sanction.","items":{"properties":{"dateISO":{"description":"The date of the event.","example":"2021-05-05","type":"string"},"evidenceIDs":{"description":"The list of evidence Ids associated with the sanction event.","example":["12422"],"items":{"$ref":"#/components/schemas/EvidenceID"},"type":"array"},"type":{"description":"Indicated what the event type was.","enum":["Added","Amended","Removed"],"example":"Added","type":"string"}},"required":["type","dateISO","evidenceIDs"],"type":"object"},"type":"array"},"measures":{"description":"The list of measures enforced by the sanctioning body.","example":["Travel Ban"],"items":{"type":"string"},"type":"array"},"regime":{"properties":{"body":{"description":"The name of the issuing body.","example":"United Nations Security Council (UNSC)","type":"string"},"name":{"description":"The name of the sanction Regime allocated by the sanctioning. body.","example":"Iranian Sanctions List","type":"string"},"origin":{"description":"The country or region that issues the sanctions.","example":"United Nations","type":"string"},"types":{"description":"The type of sanction classified by the sanctioning body.","example":["Non-Proliferation","Human Rights"],"items":{"enum":["Counter Narcotics","Hostile Activities","Human Rights","Non-Proliferation","Territorial Violation","Terrorism"],"type":"string"},"type":"array"}},"required":["body","origin"],"type":"object"},"sanctionID":{"description":"The sanction ID provided by the sanctioning body.","example":"124122","type":"string"}},"required":["measures","regime","events"],"type":"object"},"SoeSchema":{"properties":{"evidenceIDs":{"description":"The list of supporting evidence.","example":["526342","125113"],"items":{"$ref":"#/components/schemas/EvidenceID"},"type":"array"},"level":{"description":"Indicates whether this is a nation or local SOE.","enum":["National","Local"],"example":"National","type":"string"},"status":{"description":"Indicates whether the SOE is current or former.","enum":["Current","Former"],"example":"Current","type":"string"}},"required":["level","status","evidenceIDs"],"type":"object"}},"securitySchemes":{"ApiKeyAuth":{"in":"header","name":"X-API-KEY","type":"apiKey"}}},"info":{"description":"Compliance Screening","title":"Compliance Screening","version":"1.0.0"},"openapi":"3.0.3","paths":{"/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-screening)\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 click one of the HTTP response codes at the bottom to see an example of that specific response!\n","operationId":"search_businesses","parameters":[{"description":"the provider of the compliance screening data","in":"query","name":"provider","required":true,"schema":{"default":"kyc_aml","enum":["kyc_aml"]}},{"description":"All the parameters that can be applied to the persons search","in":"query","name":"match","schema":{"$ref":"#/components/schemas/BusinessesSearchMatch"},"style":"deepObject"},{"description":"`size`defines the number of records to return in each page. default value: 10, maximum value: 20. <br>`number`specifies the page number.","in":"query","name":"page","schema":{"$ref":"#/components/schemas/Page"},"style":"deepObject"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BusinessesList"}}},"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"}},"summary":"Search Businesses","tags":["Search"]}},"/businesses/{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-screening)\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 click one of the HTTP response codes at the bottom to see an example of that specific response!\n","operationId":"get_business_profile","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/FullBusinessObject"}}},"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"}},"summary":"Get Business profile","tags":["Profile"]}},"/businesses/{id}/evidences/copyrighted/{evidenceID}":{"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-screening)\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 click one of the HTTP response codes at the bottom to see an example of that specific response!\n","operationId":"get_business_copyrighted_evidence","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"$ref":"#/components/parameters/EvidenceID"}],"responses":{"200":{"$ref":"#/components/responses/EvidencePDF"},"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"},"504":{"$ref":"#/components/responses/GatewayTimeout"}},"summary":"Get copyrighted evidence of a Business","tags":["Evidence"]}},"/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-screening)\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 click one of the HTTP response codes at the bottom to see an example of that specific response!\n","operationId":"search_persons","parameters":[{"description":"the provider of the compliance screening data","in":"query","name":"provider","required":true,"schema":{"default":"kyc_aml","enum":["kyc_aml"]}},{"description":"All the parameters that can be applied to the persons search","in":"query","name":"match","schema":{"$ref":"#/components/schemas/PersonsSearchMatch"},"style":"deepObject"},{"description":"`size`defines the number of records to return in each page. default value: 10, maximum value: 20. <br>`number`specifies the page number.","in":"query","name":"page","schema":{"$ref":"#/components/schemas/Page"},"style":"deepObject"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/PersonsList"}}},"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"}},"summary":"Search Persons","tags":["Search"]}},"/persons/{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-screening)\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 click one of the HTTP response codes at the bottom to see an example of that specific response!\n","operationId":"get_person_profile","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/FullPersonObject"}}},"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"}},"summary":"Get Person Profile","tags":["Profile"]}},"/persons/{id}/evidences/copyrighted/{evidenceID}":{"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-screening)\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 click one of the HTTP response codes at the bottom to see an example of that specific response!\n","operationId":"get_person_copyrighted_evidence","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/ID"}},{"$ref":"#/components/parameters/EvidenceID"}],"responses":{"200":{"$ref":"#/components/responses/EvidencePDF"},"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"},"504":{"$ref":"#/components/responses/GatewayTimeout"}},"summary":"Get copyrighted evidence of a Person","tags":["Evidence"]}}},"security":[{"ApiKeyAuth":[]}],"servers":[{"url":"https://api.company.info/compliance/screening"}],"x-readme":{"proxy-enabled":false}}