New endpoint: [GET] – system/coverage
Posted 2024-07-19
|
Updated 2024-07-24
We are excited to announce the launch of our new KYC API v2 endpoint: coverage details. This endpoint provides comprehensive information on available sources, datasets, documents, searches, and concierge products for each jurisdiction. It is designed to help you better understand the coverage and connection status of data in various countries.
Endpoint details
Request
curl --location 'https://api.kompany.com/api/v2/system/coverage' --header 'user_key: {secret}'
Parameters
For an accurate technical description refer to the endpoint in our console.countryCode refers to 2 or 5 digit code for the country, example: AT or US-DE.
countryConnectionType refers to the type of connection to the country’s data sources. Possible values are: L: Live, RU: Live – Regular Updates, BC: Business Concierge, D: Discontinued, NC: Not Covered Yet.
continent refers to the continent the country is located in. Possible values are: EU: Europe, AS: Asia:, NA: North America, AF: Africa, OC: Oceania, SA: South America.
To utilize this endpoint effectively, you may include the following optional query parameters in your request.
For simplicity, the response provided here is limited to data pertaining to Austria (AT).
Response
[
{
"countryCode": "AT",
"countryName": "Austria",
"continent": "Europe",
"countryConnectionType": "LIVE",
"updateFrequency": null,
"status": "LIVE",
"sources": [
{
"sourceName": "Ministry of Justice Company register",
"sourceNameLong": "Ministry of Justice Company register (Firmenbuch)",
"isPrimarySource": true,
"sourceStatus": "LIVE",
"sourceConnectionType": "LIVE",
"sourceId": "35f4a8d465e6e1edc05f3d8ab658c551"
},
{
"sourceName": "GISA Business Information System Austria",
"sourceNameLong": "GISA Business Information System Austria (GISA Gewerbeinformationssystem Austria)",
"isPrimarySource": false,
"sourceStatus": "LIVE",
"sourceConnectionType": "LIVE",
"sourceId": "65ded5353c5ee48d0b7d48c591b8f430"
},
{
"sourceName": "Register of associations",
"sourceNameLong": "Register of associations (Vereinsregister)",
"isPrimarySource": false,
"sourceStatus": "LIVE",
"sourceConnectionType": "LIVE",
"sourceId": "9fc3d7152ba9336a670e36d0ed79bc43"
},
{
"sourceName": "Ministry of Justice Land register",
"sourceNameLong": "Ministry of Justice Land register (Grundbuch)",
"isPrimarySource": false,
"sourceStatus": "LIVE",
"sourceConnectionType": "LIVE",
"sourceId": "02522a2b2726fb0a03bb19f2d8d9524d"
},
{
"sourceName": "Credit Protection Association of 1870",
"sourceNameLong": "Credit Protection Association of 1870 (Kreditschutzverband von 1870- KSV)",
"isPrimarySource": false,
"sourceStatus": "LIVE",
"sourceConnectionType": "LIVE",
"sourceId": "7f1de29e6da19d22b51c68001e7e0e54"
}
],
"datasets": [
{
"productName": "Refresh Dataset AT",
"productType": "REFRESHED_DATA_AT",
"productCategory": "Dataset government fee",
"productDescription": "Refresh dataset in Austria",
"countryCode": "AT",
"estimatedDeliverySeconds": 0,
"price": "1.500",
"priceTier": "C",
"priceCurrency": "EUR",
"relatedProductType": [
"REFRESHED_DATA"
],
"sourceId": "35f4a8d465e6e1edc05f3d8ab658c551"
},
{
"productName": "Refresh Dataset VR AT",
"productType": "REFRESHED_DATA_ATVR",
"productCategory": "Dataset government fee",
"productDescription": "Refresh dataset in Austria for VR",
"countryCode": "AT",
"estimatedDeliverySeconds": 0,
"price": "1.500",
"priceTier": "C",
"priceCurrency": "EUR",
"relatedProductType": [
"REFRESHED_DATA"
],
"sourceId": "9fc3d7152ba9336a670e36d0ed79bc43"
},
{
"productName": "Refresh Dataset GISA AT",
"productType": "REFRESHED_DATA_ATGISA",
"productCategory": "Dataset government fee",
"productDescription": "Refresh dataset in Austria for GISA",
"countryCode": "AT",
"estimatedDeliverySeconds": 0,
"price": "1.500",
"priceTier": "C",
"priceCurrency": "EUR",
"relatedProductType": [],
"sourceId": "65ded5353c5ee48d0b7d48c591b8f430"
},
{
"productName": "Refresh Dataset AT Land Register",
"productType": "REFRESH_DATA_ATLANDREGISTER",
"productCategory": "Dataset government fee",
"productDescription": "Refresh dataset in Austria Land Register",
"countryCode": "AT",
"estimatedDeliverySeconds": 0,
"price": "1.500",
"priceTier": "C",
"priceCurrency": "EUR",
"relatedProductType": [],
"sourceId": "02522a2b2726fb0a03bb19f2d8d9524d"
}
],
"searches": [
{
"productName": "Deepsearch by Number AT",
"productType": "DEEPSEARCH_DATA_NUMBER_AT",
"productCategory": "Search government fee",
"productDescription": "Live search government fee in Austria",
"countryCode": "AT",
"estimatedDeliverySeconds": 0,
"price": "0.000",
"priceTier": null,
"priceCurrency": "EUR",
"relatedProductType": [
"DEEPSEARCH_DATA_NUMBER_GENERAL"
],
"sourceId": "35f4a8d465e6e1edc05f3d8ab658c551"
},
{
"productName": "Deepsearch by Name VR AT",
"productType": "DEEPSEARCH_DATA_NAME_ATVR",
"productCategory": "Search government fee",
"productDescription": "Live search government fee in Austria for VR",
"countryCode": "AT",
"estimatedDeliverySeconds": 0,
"price": "0.000",
"priceTier": null,
"priceCurrency": "EUR",
"relatedProductType": [
"DEEPSEARCH_DATA_NAME_GENERAL"
],
"sourceId": "9fc3d7152ba9336a670e36d0ed79bc43"
},
{
"productName": "Deepsearch by Number VR AT",
"productType": "DEEPSEARCH_DATA_NUMBER_ATVR",
"productCategory": "Search government fee",
"productDescription": "Live search government fee in Austria for VR",
"countryCode": "AT",
"estimatedDeliverySeconds": 0,
"price": "0.000",
"priceTier": null,
"priceCurrency": "EUR",
"relatedProductType": [
"DEEPSEARCH_DATA_NUMBER_GENERAL"
],
"sourceId": "9fc3d7152ba9336a670e36d0ed79bc43"
},
{
"productName": "Deepsearch by Name GISA AT",
"productType": "DEEPSEARCH_DATA_NAME_ATGISA",
"productCategory": "Search government fee",
"productDescription": "Live search government fee in Austria for GISA",
"countryCode": "AT",
"estimatedDeliverySeconds": 0,
"price": "0.000",
"priceTier": null,
"priceCurrency": "EUR",
"relatedProductType": [],
"sourceId": "65ded5353c5ee48d0b7d48c591b8f430"
},
{
"productName": "Deepsearch by Number GISA AT",
"productType": "DEEPSEARCH_DATA_NUMBER_ATGISA",
"productCategory": "Search government fee",
"productDescription": "Live search government fee in Austria for GISA",
"countryCode": "AT",
"estimatedDeliverySeconds": 0,
"price": "0.000",
"priceTier": null,
"priceCurrency": "EUR",
"relatedProductType": [],
"sourceId": "65ded5353c5ee48d0b7d48c591b8f430"
},
{
"productName": "Deepsearch by Name AT",
"productType": "DEEPSEARCH_DATA_NAME_AT",
"productCategory": "Search government fee",
"productDescription": "Live search government fee in Austria",
"countryCode": "AT",
"estimatedDeliverySeconds": 0,
"price": "0.000",
"priceTier": null,
"priceCurrency": "EUR",
"relatedProductType": [],
"sourceId": "35f4a8d465e6e1edc05f3d8ab658c551"
}
],
"products": [
{
"productName": "Annual Accounts",
"productType": "ADDAAHFAT",
"productCategory": "Document government fee",
"productDescription": "Financial data of the company retrieved in real time from the primary source",
"countryCode": "AT",
"estimatedDeliverySeconds": 19,
"price": "9.000",
"priceTier": "E",
"priceCurrency": "EUR",
"relatedProductType": [
"PRODMARKU"
],
"sourceId": "35f4a8d465e6e1edc05f3d8ab658c551"
},
{
"productName": "Articles of Association",
"productType": "ADDASHFAT",
"productCategory": "Document government fee",
"productDescription": "Founding documents of the company retrieved in real time from the primary source",
"countryCode": "AT",
"estimatedDeliverySeconds": 20,
"price": "9.000",
"priceTier": "E",
"priceCurrency": "EUR",
"relatedProductType": [
"PRODMARKU"
],
"sourceId": "35f4a8d465e6e1edc05f3d8ab658c551"
},
{
"productName": "Credit Check",
"productType": "ADDCCKSAT",
"productCategory": "Document government fee",
"productDescription": "Credit details retrieved in real time",
"countryCode": "AT",
"estimatedDeliverySeconds": 22,
"price": "24.000",
"priceTier": "G",
"priceCurrency": "EUR",
"relatedProductType": [
"PRODMARKU"
],
"sourceId": "7f1de29e6da19d22b51c68001e7e0e54"
},
{
"productName": "Credit Report",
"productType": "ADDCRKSAT",
"productCategory": "Document government fee",
"productDescription": "Credit data retrieved in real time",
"countryCode": "AT",
"estimatedDeliverySeconds": 26,
"price": "34.000",
"priceTier": "H",
"priceCurrency": "EUR",
"relatedProductType": [
"PRODMARKU"
],
"sourceId": "e4da3b7fbbce2345d7772b0674a318d5"
},
{
"productName": "Grundbuch Report AT",
"productType": "ADDLDBZAT",
"productCategory": "Document government fee",
"productDescription": "Official extract from the land register retrieved in real time",
"countryCode": "AT",
"estimatedDeliverySeconds": 3,
"price": "9.000",
"priceTier": "E",
"priceCurrency": "EUR",
"relatedProductType": [],
"sourceId": "38b3eff8baf56627478ec76a704e9b52"
},
{
"productName": "Grundbuch Extract AT",
"productType": "ADDLSBZAT",
"productCategory": "Document government fee",
"productDescription": "Official data from the land register retrieved in real time",
"countryCode": "AT",
"estimatedDeliverySeconds": 1,
"price": "9.000",
"priceTier": "E",
"priceCurrency": "EUR",
"relatedProductType": [],
"sourceId": null
},
{
"productName": "Registration Details",
"productType": "ADDOFGSAT",
"productCategory": "Document government fee",
"productDescription": "Official company data retrieved in real time from the primary source",
"countryCode": "AT",
"estimatedDeliverySeconds": 0,
"price": "4.000",
"priceTier": "D",
"priceCurrency": "EUR",
"relatedProductType": [],
"sourceId": "65ded5353c5ee48d0b7d48c591b8f430"
},
{
"productName": "Registration Details",
"productType": "ADDOFVRAT",
"productCategory": "Document government fee",
"productDescription": "Official company data retrieved in real time from the primary source",
"countryCode": "AT",
"estimatedDeliverySeconds": 76,
"price": "4.000",
"priceTier": "D",
"priceCurrency": "EUR",
"relatedProductType": [
"PRODMARKU"
],
"sourceId": "9fc3d7152ba9336a670e36d0ed79bc43"
},
{
"productName": "Official Filings",
"productType": "DOCOFFBAT",
"productCategory": "Document government fee",
"productDescription": "Company documents filed with the official primary source retrieved in real time",
"countryCode": "AT",
"estimatedDeliverySeconds": 3064,
"price": "9.000",
"priceTier": "E",
"priceCurrency": "EUR",
"relatedProductType": [
"PRODMARKU"
],
"sourceId": "35f4a8d465e6e1edc05f3d8ab658c551"
},
{
"productName": "Register Report",
"productType": "REPOFHFAT",
"productCategory": "Document government fee",
"productDescription": "Official register extract retrieved in real time from the primary source",
"countryCode": "AT",
"estimatedDeliverySeconds": 53,
"price": "9.000",
"priceTier": "E",
"priceCurrency": "EUR",
"relatedProductType": [
"PRODMARKU"
],
"sourceId": "35f4a8d465e6e1edc05f3d8ab658c551"
}
],
"otherServices": [],
"conciergeProducts": []
}
]
Functionality
In the response, a list of all supported details on a jurisdiction are provided and categorized by sources, connection status and pricing information. The endpoint categorizes countries by their countryConnectionType, which indicates the type (nature) of the connection to each country’s data sources. These connections can be LIVE, LIVE – REGULAR UPDATES, BUSINESS CONCIERGE, DISCONTINUED, and NOT COVERED YET.
For a more detailed description on each connection type, please refer to the technical documentation available in the guides section at the system category.[
{
"countryCode": "string",
"countryName": "string",
"continent": "string",
"countryConnectionType": "string",
"updateFrequency": "string",
"status": "string",
"sources": [...],
"datasets": [...],
"searches": [...],
"products": [...],
"otherServices": [...],
"conciergeProducts": [...]
}
]
In the simplified JSON structure highlighted above, there are six primary objects included in the response.
- sources lists all supported data sources for a given jurisdiction, with each source being assigned a unique sourceId. This identifier is subsequently linked to relevant searches, products, datasets, and more.
- datasets provides information about various datasets (refresh, enhanced, beneficial owners) available from the sources.
- searches provides information about various live searches (number, name) available from the sources.
- products lists documents available for a jurisdiction.
- otherServices provides additional general verification services (e.g. EIN validation) offered independently to the country. Use the corresponding countryCode “XX” to retrieve these services.
- conciergeProducts lists all available business concierge documents which are not available through live connections.
It’s important to note that the price information you retrieve is directly tied to your application’s plan. Therefore, depending on the details of your API plan, you may notice differences in certain fields and in the price information itself.
Accessing the endpoint
To access this endpoint and for a more detailed technical description, please visit the endpoint in our console, and also the technical documentation provided in the guides section at the system category. Feel free to explore the new endpoint and integrate it into your applications to leverage its full potential!
For any questions or further assistance, please contact us here: ma_kyc_support@moodys.com.