Metadata API (4)

Download OpenAPI specification:Download

A comprehensive suite of services that provides access to CDQ metadata. It is designed to offer basic services to apply such a metadata, for instance, for parsing.

DataSources

Read Data Source Metadata

Provides metadata on external data sources such as legal forms, address data, or legal entity data. Results are paged by optional query parameters and filtered by additional parameters such as country short name or concepts provided by the particular data source.

SecurityapiKey
Request
query Parameters
aleiPrefix
string

Prefix of the database name, according to ALEI standard.

Example: aleiPrefix=DE.RC
countryShortName
string

Country short name, i.e., the 2-digit ISO code.

Example: countryShortName=CH
implementationStatus
string

DEPRECATED, use 'releaseStatus' instead.

Example: implementationStatus=ACTIVE
managedConceptTechnicalKey
string

Technical key of a CDQ data model concept.

Example: managedConceptTechnicalKey=LEGAL_FORM
preferredInCountry
string

ISO code of a country this data source is used in as a preferred data source for compiling golden records.

Example: preferredInCountry=CH
primaryInCountry
string

ISO code of a country this data source is used in as a primary data source for compiling golden records.

Example: primaryInCountry=CH
releaseStatus
Array of integers

See https://meta.cdq.com/Property:Release_status for semantics. According to CDLD-22386 list of 4,5,6,7, corresponds to active data sources

Example: releaseStatus=4,5,6,7
technicalKey
string

Technical key.

Example: technicalKey=DE_RC
unallowedInCountry
string

ISO code of a country this data source is not allowed to be used in for compiling golden records.

Example: unallowedInCountry=CH
Responses
200

OK

get/v3/datasources
Request samples
Response samples
application/json
{
  • "pageSize": "10",
  • "page": "1",
  • "total": "100",
  • "values": [
    ]
}

Identifiers

-> Categorize the API endpoints related to operations on identifiers. These operations include getting a list of identifier issuing bodies, which can be filtered and paged by optional query parameters. The metadata provided includes technical keys, names, descriptions, jurisdictions, and associated identifier types among others.