Skip to content

Referencedata API (4)

This API provides services to search and read reference data

Overview
URL

https://www.cdq.ch/team

Krystian Sola

krystian.sola@cdq.ch

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/

Production SOAP

https://api.corporate-data-league.ch/referencedata/soap/v4/

Production

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

Business Partners

Everything about Business Partners

Operations

Analytics

Everything about reference data analytics

Registrations

Registrations

Operations

Addresses

Everything about Addresses

Operations

Bulk Fetch

Operations

Bulk Lookup

Operations

Cancel Bulk

Operations

CEDEX Lookup

Operations

Batch Lookup

Operations

Batch Lookup Result

Operations

Administrative Area Index

Operations

Search Reference Business Partners

Request

Search in Reference Business Partners by Administrative Area.

Security
basicAuth
Query
countrystringrequired

Country consisting of the country name and country code (ISO 3166-1 alpha-2).

Example: country=Switzerland CH
postCodestring

A country specific code for a certain Address.

Example: postCode=8001
administrativeAreaValuestring

Name of the Administrative Area.

Example: administrativeAreaValue=Sankt Gallen
administrativeAreaShortNamestring

Abbreviation for the Administrative Area.

Example: administrativeAreaShortName=St. Gallen
curl -i -X GET \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/administrativeareaindex/find?country=Switzerland+CH'

Responses

OK

Bodyapplication/jsonArray [
countryCodestring(CountryShortName)

Country code (ISO 3166-1 alpha-2).

Example: "CH"
dataSourcestring(BusinessPartnerStorageDataSourceId)

Unique identifier for a Data Source of the Storage.

Example: "648824a691d8d2503d65103e"
ordinalinteger

The ordinal number of the address.

Example: "1"
administrativeAreaobject(AdministrativeAreaResult)

A top-level geographical or political area division in a country.

]
Response
application/json
[
  {
    "countryCode": "CH",
    "dataSource": "648824a691d8d2503d65103e",
    "ordinal": "1",
    "administrativeArea": { … }
  }
]

DNB

Operations

Configurations

Operations

Processing Logs

Operations