Skip to content

Metadata API (5)

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.

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/metadata-api/api-v5/

Production SOAP

https://api.corporate-data-league.ch/metadata-api/soap/v5/

Production

https://api.corporate-data-league.ch/metadata-api/

Knowledge Graphs

-> Categorize the API endpoints related to operations on Knowledge Graphs. These operations include reading Knowledge Graphs, reading a Knowledge Graph by ID, downloading a Knowledge Graph, reading Business Rules, and getting custom validation settings.

Operations

SAP mappings

-> Categorize the API endpoints related to operations on SAP identifier mappings. These operations include reading SAP identifier mappings and analyzing SAP identifier mappings.

Operations

APIs

-> Categorize the API endpoints related to operations on APIs. These operations include reading API metadata. The metadata provided includes endpoint descriptions, related features, and use cases.

Operations

Character Sets

-> Categorize the API endpoints related to operations on character sets. These operations include reading character sets metadata. The metadata provided includes character set names and technical keys.

Operations

Concepts

-> Categorize the API endpoints related to operations on concepts. These operations include reading concept metadata. The metadata provided includes concept names, technical keys, and parent concept technical keys.

Operations

Counties

-> Categorize the API endpoints related to operations on counties. These operations include reading county metadata. The metadata provided includes county names, region short names, and region values.

Operations

Countries

-> Categorize the API endpoints related to operations on countries. These operations include reading country metadata. The metadata provided includes country names, country short names, and country technical keys.

Operations

DataSources

-> Categorize the API endpoints related to operations on data sources. These operations include reading data source metadata. The metadata provided includes data source names, data source technical keys, and data source categories.

Operations

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.

Operations

Languages

-> Categorize the API endpoints related to operations on languages. These operations include reading language metadata. The metadata provided includes language names, language technical keys, and language codes.

Operations

LegalForms

-> Categorize the API endpoints related to operations on legal forms. These operations include reading legal form metadata. The metadata provided includes legal form names, legal form technical keys, and legal form categories.

Operations

List Legal Form Metadata

Request

Provides a list of legal form metadata, optionally filtered by country short name. Results are provided on pages, paged by optional query parameters. An optional term, which may be the legal form's name or a (defective) abbreviation, can be used to get metadata for a specific legal form.

Security
basicAuth
Query
countryShortNamestring

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

Example: countryShortName=CH
termstring

Name or abbreviation of the legal form, as a filter. It Should be unique per country. No fuzzy matching but case-insensitive.

Example: term=GmbH & Co. KG
technicalKeyArray of strings

Value used to filter results by technical key.

Example: technicalKey=GMBH
pageinteger

The number of the page to read, starting with '0'.

Default 0
Example: page=1
pageSizeinteger

Maximum number of elements on the page to read.

Default 10
Example: pageSize=10
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/metadata-api/api-v5/v3/legalforms

Responses

OK

Bodyapplication/json
pageSizeinteger(PageSize)

< The size of the provided page, as specified in the request, or by the default value.

Example: "10"
pageinteger(Page)

< The number of the page, as specified in the request, or '0' as default.

Example: "1"
totalinteger(Total)

< Total number of elements across all pages.

Example: "100"
valuesArray of objects(LegalFormMetadata)

List of legal form metadata.

Response
application/json
{
  "pageSize": "10",
  "page": "1",
  "total": "100",
  "values": [
    { … }
  ]
}

Read Legal Form Metadata

Request

Matches legal form full names and abbreviations in a given string. To improve a matching outcome, a country short name has to be provided to reduce the number of potential patterns. Matching is not fuzzy but case-insensitive.

Security
basicAuth
Bodyapplication/json
countryShortNamestring

Country short name.

Example: "DE"
inputstringrequired

Input string to match legal forms.

Example: "CDQ Aktienges."
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/metadata-api/api-v5/v3/legalforms/match \
  -H 'Content-Type: application/json' \
  -d '{
    "countryShortName": "DE",
    "input": "CDQ Aktienges."
  }'

Responses

OK

Bodyapplication/json
inputstring

Input string to match legal forms.

Example: "CDQ Aktienges. St. Gallen"
inputNormalizedstring

Normalized input string to match legal forms.

Example: "CDQ Aktienges. St. Gallen"
legalFormobject(LegalFormMetadata)

Metadata for a specific legal form.

matchedStringstring

Matched a legal form in input.

Example: "Aktienges"
matchPositionStartinteger

Start position of the matched legal form in input.

Example: "4"
matchPositionEndinteger

End position of the matched legal form in input.

Example: "13"
containsLegalFormboolean

Indicates if the input contains a legal form.

Example: "true"
startsWithLegalFormboolean

Indicates if the input starts with a legal form.

Example: "true"
stringBeforeLegalFormstring

String before the legal form in input.

Example: "CDQ"
stringAfterLegalFormstring

String after the legal form in input.

Example: "St. Gallen"
stringCutAfterLegalFormstring

String cut after the legal form in input.

Example: "CDQ Aktienges."
stringWithoutLegalFormstring

Input string without legal form.

Example: "CDQ St. Gallen"
stringWithHarmonizedLegalFormstring

Input string with harmonized legal form.

Example: "CDQ AG St. Gallen"
stringWithHarmonizedLegalFormCutAfterLegalFormstring

Input string with harmonized legal form and cut after the legal form.

Example: "CDQ AG"
Response
application/json
{
  "input": "CDQ Aktienges. St. Gallen",
  "inputNormalized": "CDQ Aktienges. St. Gallen",
  "legalForm": {
    "url": "https://meta.cdq.com/Business_partner/legal_form",
    "name": "Aktiengesellschaft",
    "technicalKey": "AE_2507",
    "language": { … },
    "countryScope": "CH",
    "mainAbbreviation": "AG",
    "abbreviations": [ … ],
    "defectiveAbbreviations": [ … ],
    "internationalName": "Public Limited Company",
    "categories": [ … ]
  },
  "matchedString": "Aktienges",
  "matchPositionStart": "4",
  "matchPositionEnd": "13",
  "containsLegalForm": "true",
  "startsWithLegalForm": "true",
  "stringBeforeLegalForm": "CDQ",
  "stringAfterLegalForm": "St. Gallen",
  "stringCutAfterLegalForm": "CDQ Aktienges.",
  "stringWithoutLegalForm": "CDQ St. Gallen",
  "stringWithHarmonizedLegalForm": "CDQ AG St. Gallen",
  "stringWithHarmonizedLegalFormCutAfterLegalForm": "CDQ AG"
}

Read Legal Form Metadata by Batch

Request

Matches legal form full names and abbreviations in given strings. To improve a matching outcome, a country short name should be provided to reduce the number of potential patterns. Otherwise, legal forms from all countries will be taken into consideration. Matching is not fuzzy but case-insensitive.

Security
basicAuth
Bodyapplication/jsonArray [
countryShortNamestring

Country short name.

Example: "DE"
inputstringrequired

Input string to match legal forms.

Example: "CDQ Aktienges."
]
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/metadata-api/api-v5/v3/legalforms/matchbatch \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "countryShortName": "DE",
      "input": "CDQ Aktienges."
    }
  ]'

Responses

OK

Bodyapplication/jsonArray [
inputstring

Input string to match legal forms.

Example: "CDQ Aktienges. St. Gallen"
inputNormalizedstring

Normalized input string to match legal forms.

Example: "CDQ Aktienges. St. Gallen"
legalFormobject(LegalFormMetadata)

Metadata for a specific legal form.

matchedStringstring

Matched a legal form in input.

Example: "Aktienges"
matchPositionStartinteger

Start position of the matched legal form in input.

Example: "4"
matchPositionEndinteger

End position of the matched legal form in input.

Example: "13"
containsLegalFormboolean

Indicates if the input contains a legal form.

Example: "true"
startsWithLegalFormboolean

Indicates if the input starts with a legal form.

Example: "true"
stringBeforeLegalFormstring

String before the legal form in input.

Example: "CDQ"
stringAfterLegalFormstring

String after the legal form in input.

Example: "St. Gallen"
stringCutAfterLegalFormstring

String cut after the legal form in input.

Example: "CDQ Aktienges."
stringWithoutLegalFormstring

Input string without legal form.

Example: "CDQ St. Gallen"
stringWithHarmonizedLegalFormstring

Input string with harmonized legal form.

Example: "CDQ AG St. Gallen"
stringWithHarmonizedLegalFormCutAfterLegalFormstring

Input string with harmonized legal form and cut after the legal form.

Example: "CDQ AG"
]
Response
application/json
[
  {
    "input": "CDQ Aktienges. St. Gallen",
    "inputNormalized": "CDQ Aktienges. St. Gallen",
    "legalForm": { … },
    "matchedString": "Aktienges",
    "matchPositionStart": "4",
    "matchPositionEnd": "13",
    "containsLegalForm": "true",
    "startsWithLegalForm": "true",
    "stringBeforeLegalForm": "CDQ",
    "stringAfterLegalForm": "St. Gallen",
    "stringCutAfterLegalForm": "CDQ Aktienges.",
    "stringWithoutLegalForm": "CDQ St. Gallen",
    "stringWithHarmonizedLegalForm": "CDQ AG St. Gallen",
    "stringWithHarmonizedLegalFormCutAfterLegalForm": "CDQ AG"
  }
]

Read Legal Form Category Metadata

Request

Provides a list of legal form category metadata. Results are provided on pages, paged by optional query parameters.

Security
basicAuth
Query
pageinteger

The number of the page to read, starting with '0'.

Default 0
Example: page=1
pageSizeinteger

Maximum number of elements on the page to read.

Default 10
Example: pageSize=10
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/metadata-api/api-v5/v3/legalformcategories

Responses

OK

Bodyapplication/json
pageSizeinteger(PageSize)

< The size of the provided page, as specified in the request, or by the default value.

Example: "10"
pageinteger(Page)

< The number of the page, as specified in the request, or '0' as default.

Example: "1"
totalinteger(Total)

< Total number of elements across all pages.

Example: "100"
valuesArray of objects(LegalFormCategoryMetadata)

List of legal form category metadata.

Response
application/json
{
  "pageSize": "10",
  "page": "1",
  "total": "100",
  "values": [
    { … }
  ]
}

Linkage Strategies

-> Categorize the API endpoints related to operations on linkage strategies. These operations include reading linkage strategy metadata. The metadata provided includes linkage strategy names, linkage strategy technical keys, and linkage strategy categories.

Operations

Postal Delivery Points

-> Categorize the API endpoints related to operations on postal delivery points. These operations include reading postal delivery point metadata. The metadata provided includes postal delivery point names, postal delivery point technical keys, and postal delivery point categories.

Operations

Premises

-> Categorize the API endpoints related to operations on premises. These operations include reading premise metadata. The metadata provided includes premise names, premise technical keys, and premise categories.

Operations

Regions

-> Categorize the API endpoints related to operations on regions. These operations include reading region metadata. The metadata provided includes region names, region short names, and region values.

Operations

Regular Expressions

-> Categorize the API endpoints related to operations on regular expressions. These operations include reading regular expressions metadata. The metadata provided includes regular expression names, regular expression technical keys, and regular expression categories.

Operations

Terms

-> Categorize the API endpoints related to operations on terms. These operations include reading term metadata. The metadata provided includes term names, term technical keys, and term categories.

Operations

Thoroughfares

-> Categorize the API endpoints related to operations on thoroughfares. These operations include reading thoroughfare metadata. The metadata provided includes thoroughfare names, thoroughfare technical keys, and thoroughfare categories.

Operations

Service Quotas

Operations

Release Notes

Operations

Compliance Lists

Operations