{"openapi":"3.0.3","info":{"title":"Compliance Screening","description":"Compliance Screening","version":"1.0.0"},"servers":[{"url":"https://api.company.info/compliance/screening"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/persons":{"get":{"summary":"Search Persons","tags":["Search"],"parameters":[{"name":"provider","in":"query","required":false,"description":"the provider of the compliance screening data","schema":{"default":"kyc_aml","enum":["kyc_aml"]}},{"name":"match","in":"query","style":"deepObject","description":"All the parameters that can be applied to the persons search","schema":{"$ref":"#/components/schemas/PersonsSearchMatch"}},{"name":"page","in":"query","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.","schema":{"$ref":"#/components/schemas/Page"}}],"responses":{"200":{"description":"OK","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/PersonsList"}}},"headers":{"X-Correlation-Id":{"schema":{"type":"string","format":"uuid","description":"Unique request identifier"}},"X-Ratelimit-Limit":{"schema":{"type":"integer","description":"The number of request available in a rate limit window"}},"X-Ratelimit-Remaining":{"schema":{"type":"integer","description":"The number of requests left for the rate limit window"}},"X-Ratelimit-Reset":{"schema":{"type":"integer","description":"The Unix timestamp at which the current rate limit window resets"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/businesses":{"get":{"summary":"Search Businesses","tags":["Search"],"parameters":[{"name":"provider","in":"query","required":false,"description":"the provider of the compliance screening data","schema":{"default":"kyc_aml","enum":["kyc_aml"]}},{"name":"match","in":"query","style":"deepObject","description":"All the parameters that can be applied to the persons search","schema":{"$ref":"#/components/schemas/BusinessesSearchMatch"}},{"name":"page","in":"query","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.","schema":{"$ref":"#/components/schemas/Page"}}],"responses":{"200":{"description":"OK","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BusinessesList"}}},"headers":{"X-Correlation-Id":{"schema":{"type":"string","format":"uuid","description":"Unique request identifier"}},"X-Ratelimit-Limit":{"schema":{"type":"integer","description":"The number of request available in a rate limit window"}},"X-Ratelimit-Remaining":{"schema":{"type":"integer","description":"The number of requests left for the rate limit window"}},"X-Ratelimit-Reset":{"schema":{"type":"integer","description":"The Unix timestamp at which the current rate limit window resets"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/persons/{id}":{"get":{"summary":"Get Person Profile","tags":["Profile"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"responses":{"200":{"description":"OK","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/FullPersonObject"}}},"headers":{"X-Correlation-Id":{"schema":{"type":"string","format":"uuid","description":"Unique request identifier"}},"X-Ratelimit-Limit":{"schema":{"type":"integer","description":"The number of request available in a rate limit window"}},"X-Ratelimit-Remaining":{"schema":{"type":"integer","description":"The number of requests left for the rate limit window"}},"X-Ratelimit-Reset":{"schema":{"type":"integer","description":"The Unix timestamp at which the current rate limit window resets"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/businesses/{id}":{"get":{"summary":"Get Business profile","tags":["Profile"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ID"}}],"responses":{"200":{"description":"OK","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/FullBusinessObject"}}},"headers":{"X-Correlation-Id":{"schema":{"type":"string","format":"uuid","description":"Unique request identifier"}},"X-Ratelimit-Limit":{"schema":{"type":"integer","description":"The number of request available in a rate limit window"}},"X-Ratelimit-Remaining":{"schema":{"type":"integer","description":"The number of requests left for the rate limit window"}},"X-Ratelimit-Reset":{"schema":{"type":"integer","description":"The Unix timestamp at which the current rate limit window resets"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"PersonsSearchMatch":{"title":"Persons Search Match","type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Doe, John","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."},"datasets":{"example":"PEP,SAN","type":"string","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"},"threshold":{"type":"integer","example":90,"minimum":75,"maximum":100,"default":85},"countries":{"description":"Coma separated strings. Affects both address and nationality. Two-letter country code ISO-3166-2.","example":"NL,GB","type":"string"},"countryRequired":{"example":true,"default":false,"type":"boolean","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)."},"dateOfBirth":{"type":"string","example":"1958-06-13","description":"Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future."},"dateOfBirthMatching":{"type":"string","example":"withinThreeYears","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"]},"dateOfBirthRequired":{"example":true,"default":false,"type":"boolean","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)."},"gender":{"type":"string","example":"Male","description":"Define the gender of the person you are searching for.","enum":["Male","Female"]},"matching":{"type":"string","enum":["fuzzy","strict"],"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.","example":"fuzzy","default":"fuzzy"},"pepTiers":{"type":"string","enum":["PEP Tier 1","PEP Tier 2","PEP Tier 3"],"example":"PEP Tier 1","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."}}},"BusinessesSearchMatch":{"title":"Businesses Search Match","type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Company.Info"},"datasets":{"example":"PEP,SOE","type":"string","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"},"threshold":{"type":"integer","example":90,"minimum":75,"maximum":100,"default":85},"countries":{"example":"NL,GB","description":"Coma separated strings. Two-letter country code ISO-3166-2.","type":"string"},"countryRequired":{"example":true,"default":false,"type":"boolean","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)."},"matching":{"type":"string","enum":["fuzzy","strict"],"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.","example":"fuzzy","default":"fuzzy"}}},"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"},"MonitoringID":{"title":"Monitoring ID of the profile","example":"NQZGH3oUYAtYFw","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","type":"string"},"FullPersonObject":{"title":"person profile","description":"person full profile","type":"object","properties":{"data":{"$ref":"#/components/schemas/FullPersonDataObject"}}},"FullPersonDataObject":{"title":"person object","description":"an person object structure","type":"object","properties":{"id":{"$ref":"#/components/schemas/ID"},"type":{"type":"string"},"attributes":{"type":"object","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"],"properties":{"version":{"type":"integer","example":15346444345,"description":"The version number can be used to detect if a profile has been changed."},"firstName":{"type":"string","example":"John","description":"The first name of the person."},"middleName":{"type":"string","example":"Christofer","description":"The middle name of the person."},"lastName":{"type":"string","example":"Doe","description":"The last name of the person."},"gender":{"type":"string","description":"The gender of the person.","enum":["Male","Female"]},"isDeleted":{"type":"boolean","default":false,"example":false,"description":"A true value indicates that the person has been deleted."},"deletionReason":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","example":"Duplicate profile","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"]},"otherReason":{"type":"string","example":"Should not have been there in the first place.","description":"This value is populated when the reason enum is \"Other\"."}}},"isDeceased":{"type":"boolean","default":false,"example":false,"description":"A true value indicates that the person is deceased."},"aliases":{"type":"array","minItems":0,"description":"Defines a list of aliases for the person.","items":{"type":"object","required":["type"],"properties":{"firstName":{"type":"string","example":"Doe"},"middleName":{"type":"string"},"lastName":{"type":"string","example":"John"},"type":{"type":"string","example":"Name Spelling Variation","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"]}}}},"datesOfBirthISO":{"type":"array","minItems":0,"example":["1959-06-13","1960"],"description":"The list of birth dates for the person.","items":{"type":"string","example":"1959-06-13","description":"Date in either YYYY or YYYY-MM or YYYY-MM-DD ISO format."}},"datesOfDeathISO":{"type":"array","minItems":0,"example":["1959"],"description":"The list of death dates for the person.","items":{"type":"string","example":"1959-06-13","description":"Date in either YYYY or YYYY-MM or YYYY-MM-DD ISO format."}},"nationalitiesISOCodes":{"type":"array","minItems":0,"example":["US","NL"],"description":"List of the person's nationalities.","items":{"type":"string","example":"BG","description":"ISO country codes."}},"addresses":{"type":"array","minItems":1,"description":"The list of the person's addresses.","items":{"allOf":[{"$ref":"#/components/schemas/IndividualAddressSchema"}]}},"profileImages":{"type":"array","minItems":0,"description":"Contains a list of URLs to profiles images for the person.","items":{"type":"string"}},"notes":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/NotesSchema"}]}},"contactEntries":{"minItems":0,"type":"array","items":{"type":"object","required":["category","value"],"properties":{"category":{"type":"string","example":"Email","enum":["Telephone","Fax","Mobile","Email"]},"value":{"type":"string","example":"testemail@example.com"}}}},"identifiers":{"type":"array","minItems":0,"items":{"type":"object","required":["category","value"],"properties":{"category":{"type":"string","example":"NPI Number"},"value":{"type":"string","example":"46333"}}}},"evidences":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/IndividualEvidenceSchema"}]}},"sanEntries":{"type":"object","required":["current","former"],"properties":{"current":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/SanctionSchema"}]}},"former":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/SanctionSchema"}]}}}},"relEntries":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/RelSchema"}]}},"rreEntries":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/RreSchema"}]}},"poiEntries":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/PoiSchema"}]}},"insEntries":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/InsSchema"}]}},"ddEntries":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/DdSchema"}]}},"pepEntries":{"type":"object","required":["current","former"],"properties":{"pepTier":{"type":"string","example":"PEP Tier 2","description":"Defines the PEP tier of the person.","enum":["PEP Tier 1","PEP Tier 2","PEP Tier 3","PEP By Assocation"]},"current":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/PepSchema"}]}},"former":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/PepSchema"}]}}}},"pepByAssociationEntries":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/PepAssociationSchema"}]}},"individualLinks":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/LinkedIndividualSchema"}]}},"businessLinks":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/LinkedBusinessSchema"},{"type":"object","properties":{"individualLinks":{"type":"array","minItems":0,"description":"The list of persons that are linked to this business.","items":{"allOf":[{"$ref":"#/components/schemas/LinkedIndividualSchema"}]}}}}]}},"griEntries":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/GriSchema"}]}},"datasets":{"allOf":[{"$ref":"#/components/schemas/IndividualProfileDatasetsSchema"}]},"monitoringID":{"$ref":"#/components/schemas/MonitoringID"}}},"links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}}}}},"IndividualAddressSchema":{"type":"object","required":["addressType","countryISOCode"],"properties":{"addressType":{"type":"string","example":"Place of birth","description":"Indicates the type of address.","enum":["Place of birth","Residential","Business","Previous Residential","Previous Business"]},"line1":{"type":"string","example":"1 Main Street"},"line2":{"type":"string","example":"Weesperplein"},"postcode":{"type":"string","example":"12221"},"city":{"type":"string","example":"Amsterdam"},"county":{"type":"string","example":"Netherlands"},"countyAbbreviation":{"type":"string","example":"NL"},"countryISOCode":{"type":"string","example":"NL","description":"The ISO code of the address country."}}},"PersonsList":{"title":"paginated persons search response","description":"list of persons","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PersonDataObject"}},"meta":{"type":"object","properties":{"totalResults":{"type":"integer"},"totalPages":{"type":"integer"}}},"links":{"type":"object","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"}}}}},"PersonDataObject":{"title":"person object","description":"an person object structure","type":"object","properties":{"id":{"$ref":"#/components/schemas/ID"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"version":{"type":"integer","example":15346444345,"description":"The version number can be used to detect if a profile has changed."},"score":{"minimum":50,"maximum":100,"type":"integer","example":99,"description":"The match score of the profile."},"match":{"type":"string","example":"John Doe","description":"The name of the profile that has been matched in the search."},"name":{"type":"string","example":"John Doe","description":"The primary name of the profile."},"countries":{"type":"array","example":["US"],"items":{"type":"string"},"description":"The list of countries from the addresses and nationalities of the profile. Two-letter country code ISO-3166-2."},"datesOfBirth":{"type":"array","example":["1959","1959-08-22"],"items":{"type":"string","description":"Date in either YYYY-MM-DD or YYYY-MM or YYYY ISO format."}},"gender":{"description":"Gender, if known.","type":"string","example":"Male","enum":["Male","Female"]},"profileImage":{"type":"string","description":"The primary profile image."},"datasets":{"allOf":[{"$ref":"#/components/schemas/IndividualProfileDatasetsSchema"}]},"monitoringID":{"$ref":"#/components/schemas/MonitoringID"},"pepTier":{"type":"string","enum":["PEP Tier 1","PEP Tier 2","PEP Tier 3"],"example":"PEP Tier 1","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."}}},"links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}}}}},"NotesSchema":{"type":"object","required":["value"],"properties":{"value":{"type":"string","example":"A sample note"}}},"IndividualEvidenceSchema":{"allOf":[{"type":"object","required":["datasets"],"properties":{"datasets":{"type":"array","minItems":1,"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":{"type":"string","enum":["PEP-CURRENT","PEP-FORMER","PEP-LINKED","SAN-CURRENT","SAN-FORMER","INS","RRE","DD","POI","REL","GRI","ID","CORP"]}}}},{"$ref":"#/components/schemas/EvidenceSchema"}]},"EvidenceSchema":{"type":"object","required":["evidenceID","originalURL","captureDateISO","isCopyrighted"],"properties":{"evidenceID":{"type":"string"},"originalURL":{"type":"string","example":"https://www.example.com"},"isCopyrighted":{"type":"boolean","default":false,"example":true,"description":"This indicates whether or not the evidence is protected under copyright laws."},"title":{"type":"string","example":"Example Arrested for Money Laundering","description":"The title captured from the article."},"credibility":{"type":"string","example":"Medium","enum":["Low","Medium","High"]},"language":{"type":"string","example":"eng","description":"The ISO 639-3 code for the language of the evidence."},"summary":{"type":"string","description":"For copyrighted evidence, a text snippet from the evidence will be provided."},"keywords":{"type":"string","example":"Money Laundering, AML","description":"Key words associated with the evidence."},"captureDateISO":{"type":"string","example":"2020-01-12","description":"The ISO date that the evidence was captured into the system."},"publicationDateISO":{"type":"string","example":"2020-01-11","description":"The ISO date that the evidence was originally published."},"assetURL":{"type":"string","description":"The URL link to the PDF version of the evidence. This is only available for non-copyright sources."}}},"SanctionSchema":{"type":"object","required":["measures","regime","events"],"properties":{"sanctionID":{"type":"string","example":"124122","description":"The sanction ID provided by the sanctioning body."},"measures":{"type":"array","minItems":0,"example":["Travel Ban"],"description":"The list of measures enforced by the sanctioning body.","items":{"type":"string"}},"regime":{"type":"object","required":["body","origin"],"properties":{"body":{"type":"string","description":"The name of the issuing body.","example":"United Nations Security Council (UNSC)"},"name":{"type":"string","example":"Iranian Sanctions List","description":"The name of the sanction Regime allocated by the sanctioning. body."},"origin":{"type":"string","example":"United Nations","description":"The country or region that issues the sanctions."},"types":{"type":"array","minItems":0,"example":["Non-Proliferation","Human Rights"],"description":"The type of sanction classified by the sanctioning body.","items":{"type":"string","enum":["Counter Narcotics","Hostile Activities","Human Rights","Non-Proliferation","Territorial Violation","Terrorism"]}}}},"events":{"description":"The list of events associated with the sanction.","type":"array","minItems":0,"items":{"type":"object","required":["type","dateISO","evidenceIDs"],"properties":{"type":{"type":"string","example":"Added","description":"Indicated what the event type was.","enum":["Added","Amended","Removed"]},"dateISO":{"type":"string","example":"2021-05-05","description":"The date of the event."},"evidenceIDs":{"type":"array","minItems":0,"example":["12422"],"description":"The list of evidence Ids associated with the sanction event.","items":{"type":"string"}}}}}}},"RelSchema":{"type":"object","required":["category","subcategory","events"],"properties":{"category":{"type":"string","example":"Law Enforcement","enum":["Financial Regulator","Law Enforcement"]},"subcategory":{"type":"string","example":"Police - Avon and Somerset Police - Wanted & In Court - United Kingdom","description":"The name of the list."},"events":{"type":"array","minItems":0,"items":{"type":"object","required":["type","evidenceIDs"],"properties":{"type":{"type":"string","example":"Arrest","description":"The type of event associated with the list entry."},"currencyCode":{"type":"string","example":"USD","description":"For specific event types, there can be associated financial penalties. This field indicates the international currency code."},"amount":{"type":"integer","example":1000,"description":"For specific event types, there can be associated financial penalties. This field indicates the monetary amount."},"period":{"type":"object","description":"Indicates the length of time of the penalty.","properties":{"days":{"type":"integer"},"years":{"type":"integer"},"months":{"type":"integer"}}},"dateISO":{"type":"string","example":"2021-04-09","description":"The ISO date of the event."},"evidenceIDs":{"type":"array","minItems":0,"example":["354363"],"description":"The list of evidence associated with the REL event.","items":{"type":"string","example":"354363"}}}}}}},"RreSchema":{"type":"object","required":["category","subcategory","events"],"properties":{"category":{"type":"string","example":"Law Enforcement"},"subcategory":{"type":"string","example":"Identity Theft"},"events":{"type":"array","description":"The list of events associated with the RRE entry.","minItems":0,"items":{"type":"object","required":["type","evidenceIDs"],"properties":{"type":{"type":"string","example":"Court Proceedings in Progress: Remand","description":"The type of event associated with the list entry."},"dateISO":{"type":"string","example":"2021-04-09","description":"The ISO date associated with the event."},"evidenceIDs":{"type":"array","minItems":0,"example":["354363"],"description":"The list of evidence associated with the RRE event.","items":{"type":"string","example":"354363"}}}}}}},"PoiSchema":{"type":"object","required":["category","evidenceIDs","positions"],"properties":{"category":{"type":"string","example":"Local Government Administration","description":"The category of the Profile of Interest."},"evidenceIDs":{"type":"array","minItems":0,"example":["542622"],"description":"The list of evidence associated with the POI entry.","items":{"type":"string","example":"542622"}},"positions":{"type":"array","minItems":0,"description":"Some POI categories can include positions.","items":{"type":"object","required":["position"],"properties":{"position":{"type":"string","example":"The name of the political position."},"dateOfElectionISO":{"type":"string","deprecated":true,"description":"use dateFromISO instead","example":"2021-03-12"},"segment":{"type":"string","example":"Segment"},"countryISOCode":{"type":"string","example":"ES"},"dateFromISO":{"type":"string","example":"2021-03-12"},"dateToISO":{"type":"string","example":"2021-03-12"}}}}}},"InsSchema":{"type":"object","required":["type","evidenceIDs"],"properties":{"type":{"type":"string","example":"Individual Voluntary Arrangement","description":"The type of insolvency."},"insolvencyIDNumber":{"type":"string","description":"The unique insolvency ID number provided by the insolvency institution."},"solicitor":{"type":"string","example":"HM Revenue and Customs,, Solicitor's Office & Legal Services, South West Wing, Bush House, Strand, London, WC2B 4RD","description":"The name of the solicitor who is involved in the insolvency process."},"court":{"type":"string","example":"Voluntary Liquidation Cases","description":"The name of the court before which the insolvency case is presented."},"petitioner":{"type":"string","example":"Commissioners For Hm Revenue And Customs","description":"The person/company who files the petition."},"debt":{"type":"string","example":"GBP 5,748","description":"The amount owned by the insolvent subject."},"accountantInBankruptcyCaseNumber":{"type":"string","example":"2020/601289","description":"The unique case number provided by the Scotland's insolvency service (Accountant in Bankruptcy)."},"insolvencyStartDateISO":{"type":"string","example":"2020-10-05","description":"The start date of the insolvency."},"insolvencyEndDateISO":{"type":"string","example":"2024-10-05","description":"The end date of the insolvency."},"hearingDateISO":{"type":"string","example":"2020-10-01","description":"The date of the hearing of the insolvency case in court."},"presentedDateOfPetitionISO":{"type":"string","example":"2020-10-01","description":"The date on which the petition was presented."},"gazetteIssueDateISO":{"type":"string","example":"2020-10-05","description":"The date on which the information was published on the gazette."},"awardDateISO":{"type":"string","example":"2020-10-03","description":"The date on which the insolvency awarding institution announces its decision."},"firstOrderDateISO":{"type":"string","example":"2020-10-11","description":"The date on which the first insolvency order was made."},"evidenceIDs":{"type":"array","minItems":0,"example":["252231"],"description":"The list of the supporting evidence.","items":{"type":"string"}}}},"DdSchema":{"type":"object","required":["reason","evidenceIDs"],"properties":{"caseReference":{"type":"string","description":"The unique Companies House ID number of the disqualification.","example":"INV5943477"},"reason":{"type":"string","example":"Disqualification order or undertaking; and reporting provisions.","description":"The reason for the disqualification."},"conduct":{"type":"string","example":"Brufix Glazing System Installations Limited","description":"The name of the company that the person was acting for."},"dateFromISO":{"type":"string","example":"2021-03-09","description":"Start date of the disqualification."},"dateToISO":{"type":"string","example":"2027-03-08","description":"End date of the disqualificaiton."},"evidenceIDs":{"type":"array","minItems":0,"description":"The list of supporting evidence.","items":{"type":"string"}}}},"PepSchema":{"type":"object","required":["countryISOCode","position","evidenceIDs"],"properties":{"countryISOCode":{"type":"string","example":"GB","description":"The ISO country code of the country where the position is held."},"segment":{"type":"string","example":"Executive Branch - Head and Members of Government and Deputies","description":"The category of in scope PEP positions for a particular country."},"position":{"type":"string","example":"Prime Minister (Kryeministër) | Council of Ministers (Këshillii Ministrave)","description":"The exact political position in scope for a particular country."},"dateFromISO":{"type":"string","example":"2019","description":"The start data of the political position in format YYYY or YYYY-MM or YYYY-MM-DD."},"dateToISO":{"type":"string","example":"2022-01-01","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."},"evidenceIDs":{"type":"array","minItems":0,"example":["362233"],"description":"The list of evidence linked to the political position.","items":{"type":"string"}}}},"PepAssociationSchema":{"type":"object","required":["id","evidenceIDs"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"evidenceIDs":{"type":"array","minItems":0,"description":"The list of supporting evidence.","items":{"type":"string"}}}},"LinkedIndividualSchema":{"type":"object","required":["lastName","relationship","id","datasets"],"properties":{"firstName":{"type":"string","description":"The first name of the person.","example":"Jane"},"middleName":{"type":"string","description":"The middle name of the person.","example":"Christopher"},"lastName":{"type":"string","description":"The last name of the person.","example":"Doe"},"relationship":{"type":"string","description":"Text including names used to describe the relationship with the person.","example":"John Doe is the brother of Jane Doe."},"ownershipPercentage":{"type":"integer","minimum":1,"maximum":100,"example":75,"description":"For certain relationship type related to business ownership this value will indicate the percentage ownership when known."},"id":{"$ref":"#/components/schemas/ID"},"monitoringID":{"$ref":"#/components/schemas/MonitoringID"},"datasets":{"allOf":[{"$ref":"#/components/schemas/IndividualProfileDatasetsSchema"}]}}},"LinkedBusinessSchema":{"type":"object","required":["name","id","relationship","datasets"],"properties":{"name":{"type":"string","example":"John Doe Limited","description":"The name of the linked business."},"id":{"$ref":"#/components/schemas/ID"},"monitoringID":{"$ref":"#/components/schemas/MonitoringID"},"relationship":{"type":"string","example":"John Doe is a board member of Haribo Limited","description":"Text including names used to describe the relationship with the business."},"ownershipPercentage":{"type":"integer","minimum":1,"maximum":100,"example":75,"description":"For certain relationship type related to business ownership this value will indicate the percentage ownership when known."},"datasets":{"allOf":[{"$ref":"#/components/schemas/BusinessProfileDatasetsSchema"}]}}},"IndividualProfileDatasetsSchema":{"type":"array","minItems":1,"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":{"type":"string","enum":["PEP-CURRENT","PEP-FORMER","PEP-LINKED","SAN-CURRENT","SAN-FORMER","INS","RRE","DD","POI","REL","GRI"]}},"FullBusinessObject":{"title":"business profile","description":"business full profile","type":"object","properties":{"data":{"$ref":"#/components/schemas/FullBusinessDataObject"}}},"FullBusinessDataObject":{"title":"business object","description":"an business object structure","type":"object","properties":{"id":{"$ref":"#/components/schemas/ID"},"type":{"type":"string"},"attributes":{"type":"object","required":["version","notes","name","isDeleted","aliases","businessTypes","activities","provider","addresses","sanEntries","contactEntries","relEntries","rreEntries","poiEntries","insEntries","identifiers","individualLinks","businessLinks","evidences","griEntries","profileImages","datasets","monitoringID"],"properties":{"version":{"type":"integer","example":15346444345,"description":"The version number can be used to detect when a profile has changed."},"name":{"type":"string","example":"Govprom Ltd","description":"The full name of the Business profile."},"description":{"type":"string","example":"Fake Representative cold calling.","description":"Additional information related to the nature of the business."},"isDeleted":{"type":"boolean","default":false,"example":false,"description":"A true value indicates that the Business has been deleted."},"deletionReason":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","example":"Duplicate profile","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"]},"otherReason":{"type":"string","example":"Should not have been there in the first place.","description":"This value is populated when the reason enum is \"Other\"."}}},"aliases":{"type":"array","minItems":0,"description":"Defines a list of aliases for the business.","items":{"type":"object","required":["type","alias"],"properties":{"alias":{"type":"string","example":"Govprom"},"type":{"type":"string","example":"Original Script Name","description":"This field indicates the type of the alias.","enum":["Original Script Name","Name Spelling Variation","Name Abbreviation","Previous Name","Brand Name","Fake Name"]}}}},"addresses":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/BusinessAddressSchema"}]}},"profileImages":{"type":"array","minItems":0,"description":"Contains a list of URLs to profiles images for the Business.","items":{"type":"string"}},"notes":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/NotesSchema"}]}},"contactEntries":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/ContactEntriesBusinessSchema"}]}},"businessTypes":{"type":"array","minItems":0,"example":["Bank"],"description":"Indicated the type of business profile.","items":{"type":"string","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"]}},"activities":{"type":"array","minItems":0,"example":["Securities broker","Electric car manufacturer"],"description":"The list of business activities.","items":{"type":"string"}},"identifiers":{"type":"array","minItems":0,"items":{"type":"object","required":["category","value"],"properties":{"category":{"type":"string","example":"VAT/Tax Number"},"value":{"type":"string","example":"463336244428"}}}},"evidences":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/BusinessEvidenceSchema"}]}},"sanEntries":{"type":"object","required":["current","former"],"properties":{"current":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/SanctionSchema"}]}},"former":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/SanctionSchema"}]}}}},"relEntries":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/RelSchema"}]}},"rreEntries":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/RreSchema"}]}},"poiEntries":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/PoiSchema"}]}},"insEntries":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/InsSchema"}]}},"individualLinks":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/LinkedIndividualSchema"}]}},"businessLinks":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/LinkedBusinessSchema"}]}},"griEntries":{"type":"array","minItems":0,"items":{"allOf":[{"$ref":"#/components/schemas/GriSchema"}]}},"soeEntry":{"allOf":[{"$ref":"#/components/schemas/SoeSchema"}]},"datasets":{"allOf":[{"$ref":"#/components/schemas/BusinessProfileDatasetsSchema"}]},"monitoringID":{"$ref":"#/components/schemas/MonitoringID"}}},"links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}}}}},"BusinessAddressSchema":{"type":"object","required":["addressType","countryISOCode"],"properties":{"addressType":{"type":"string","description":"Indicated the type of address.","enum":["Registered","Operating","Previous","Branch Office","Representative Office","Headquarters"]},"line1":{"type":"string","example":"17 Cobble Drive","description":"The first line of the address."},"line2":{"type":"string","example":"Manhattan","description":"The second line of the address."},"postcode":{"type":"string","example":"RE11 66G","description":"The postcode of the address."},"city":{"type":"string","example":"Katowice","description":"The city of the address."},"county":{"type":"string","example":"Countyville","description":"The county of the address."},"countyAbbreviation":{"type":"string","example":"CVL","description":"The abreviation of the country if appropriate."},"countryISOCode":{"type":"string","example":"PL","description":"The ISO country code of the address."}}},"ContactEntriesBusinessSchema":{"type":"object","required":["category","value"],"properties":{"category":{"type":"string","example":"Telephone","enum":["Telephone","Fax","Website"]},"value":{"type":"string","example":"https://www.example.com"}}},"BusinessEvidenceSchema":{"allOf":[{"type":"object","required":["datasets"],"properties":{"datasets":{"type":"array","minItems":1,"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":{"type":"string","enum":["SAN-CURRENT","SAN-FORMER","INS","RRE","POI","REL","SOE-CURRENT","SOE-FORMER","GRI","ID","CORP","PEP-CURRENT"]}}}},{"$ref":"#/components/schemas/EvidenceSchema"}]},"GriSchema":{"type":"object","required":["evidenceID","title","summary","keywords"],"properties":{"evidenceID":{"type":"string","example":"235343","description":"The ID of supporting evidence."},"title":{"type":"string","example":"EDD Report - Executive Summary Report","description":"The title of the GRI report."},"summary":{"type":"string","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.","description":"The description of the GRI report."},"keywords":{"type":"string","example":"Source of Wealth","description":"Keywords associated with the report."}}},"SoeSchema":{"type":"object","required":["level","status","evidenceIDs"],"properties":{"level":{"type":"string","example":"National","description":"Indicates whether this is a nation or local SOE.","enum":["National","Local"]},"status":{"type":"string","example":"Current","description":"Indicates whether the SOE is current or former.","enum":["Current","Former"]},"evidenceIDs":{"type":"array","example":["526342","125113"],"minItems":0,"description":"The list of supporting evidence.","items":{"type":"string"}}}},"BusinessesList":{"title":"businesses search response","description":"list of businesses","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BusinessDataObject"}},"meta":{"type":"object","properties":{"totalResults":{"type":"integer"},"totalPages":{"type":"integer"}}},"links":{"type":"object","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"}}}}},"BusinessDataObject":{"title":"business object","description":"an business object structure","type":"object","properties":{"id":{"$ref":"#/components/schemas/ID"},"type":{"type":"string"},"attributes":{"type":"object","required":["datasets","id","score","match","name","countries"],"properties":{"version":{"type":"integer","example":15346444345,"description":"The version number can be used to detect when a profile has been changed."},"score":{"minimum":50,"maximum":100,"type":"integer","example":99,"description":"The match score of the profile."},"match":{"type":"string","example":"IBM Corp","description":"The name of the profile that has been matched in the search."},"name":{"type":"string","example":"IBM Corporation","description":"The primary name of the profile."},"countries":{"type":"array","example":["US"],"items":{"type":"string"},"description":"The list of countries from the addresses and nationalities of the profile."},"datasets":{"type":"array","minItems":1,"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":{"type":"string","enum":["PEP","PEP-LINKED","SAN","SAN-CURRENT","SAN-FORMER","INS","RRE","REL","POI","SOE-CURRENT","SOE-FORMER"]}},"monitoringID":{"$ref":"#/components/schemas/MonitoringID"}}},"links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}}}}},"BusinessProfileDatasetsSchema":{"type":"array","minItems":1,"description":"The profile datasets\n * PEP-LINKED - Only linked PEPs (PEP by Association)\n * SAN-CURRENT - Only current Sanctions\n * SAN-FORMER - Only former Sanctions\n * INS - Insolvency\n * RRE - Reputational Risk Exposure\n * POI - Profile Of Interest\n * REL - Regulatory Enforcement List\n * SOE-CURRENT - Only current SOE\n * SOE-FORMER - Only former SOE\n * GRI - Gambling Risk Intelligence (not available for Search endpoint)\n","example":["INS","PEP-LINKED","POI","REL","RRE","SAN-CURRENT","SAN-FORMER","SOE-CURRENT","GRI"],"items":{"type":"string","enum":["PEP-LINKED","SAN-CURRENT","SAN-FORMER","INS","RRE","POI","REL","SOE-CURRENT","SOE-FORMER","GRI"]}},"JSONAPIResourceObject":{"title":"JSON:API Resource Object","description":"JSON:API Resource Object","type":"object","required":["type"],"properties":{"type":{"title":"JSON:API type Member","description":"JSON:API type Member","type":"string"},"id":{"title":"JSON:API id Member","description":"JSON:API id Member","type":"string"},"links":{"$ref":"#/components/schemas/JSONAPILinksObject"}}},"JSONAPILinksObject":{"title":"JSON:API Links Object","description":"May contain `self`, `related`, or pagination links (first, last, prev, next).","properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"},"related":{"$ref":"#/components/schemas/JSONAPILink"},"first":{"$ref":"#/components/schemas/JSONAPILink"},"last":{"$ref":"#/components/schemas/JSONAPILink"},"prev":{"$ref":"#/components/schemas/JSONAPILink"},"next":{"$ref":"#/components/schemas/JSONAPILink"}}},"JSONAPILink":{"title":"JSON:API Link","description":"A JSON:API link can be either a URL string or a structured link object.","oneOf":[{"type":"string","format":"url","example":"https://example.com/"},{"$ref":"#/components/schemas/JSONAPILinkObject"}]},"JSONAPILinkObject":{"title":"JSON:API Link Object","description":"a structured representation of a URL","type":"object","required":["href"],"properties":{"href":{"type":"string","example":"/organizations/<cin>"},"meta":{"type":"object","example":{"count":"10"}}}},"JSONAPIRelationshipLink":{"title":"JSON:API Relationship Link Object","description":"a structured representation of a Relationship","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}}},"links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}}}}},"JSONAPIErrorResponse":{"title":"JSON:API Error Response","type":"object","required":["errors"],"properties":{"errors":{"title":"An array of Error objects","type":"array","minItems":1,"items":{"type":"object","required":["status","code","title","detail"],"properties":{"status":{"description":"the HTTP status code applicable to this problem","type":"string","minLength":3,"maxLength":3},"code":{"description":"an application-specific error code. It can be the same as 'status'","type":"string"},"title":{"description":"a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization","type":"string"},"detail":{"description":"a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized","type":"string"}}}}}},"Page":{"type":"object","properties":{"size":{"type":"integer","default":10,"description":"The number of records to return in each page."},"number":{"type":"integer","default":1,"description":"This parameter specifies the page number."}}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}}}}}}