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

Autocomplete Address

Request

Support partial address input and return smart, structured suggestions.

Security
basicAuth
Bodyapplication/jsonrequired
querystring(AddressAutocompleteQuery)[ 3 .. 1000 ] charactersrequired

The search query for address autocomplete.

Example: "CHE Lukas 4"
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/v4/addresses/autocomplete \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "CHE Lukas 4"
  }'

Responses

OK

Bodyapplication/json
statusobject(Status)

Details about status or error of a service

requestobject(AddressAutocompleteRequest)

Request parameters for address autocomplete.

valuesArray of objects(AddressAutocompleteSuggestion)

List of address suggestions.

totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
Response
application/json
{
  "status": {
    "code": "200",
    "technicalKey": "OK",
    "details": [ … ],
    "path": "/v2/businesspartners/lookup",
    "timestamp": "2019-08-31T16:47+00:00"
  },
  "request": {
    "query": "CHE Lukas 4",
    "startAfter": "5712566172571652"
  },
  "values": [
    { … }
  ],
  "total": "67",
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652"
}

Lookup Address

Request

Lookup address by address data. It is possible to search by:

  • thoroughfare
  • locality
  • administrativeArea
  • postCode
  • country
Security
basicAuth
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired

cmd

searchstring

Generic search string.

Example: "Zurich"
countryobject

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

groupBystring

Grouping of results with respect to the given value.

Enum ValueDescription
ADMINISTRATIVE_AREA

Group results by administrative area.

LOCALITY

Group results by locality.

POST_CODE

Group results by post code.

THOROUGHFARE

Group results by thoroughfare.

COUNTRY

Group results by country.

Example: "LOCALITY"
localitiesArray of objects(ValueParam)

List of localities.

administrativeAreasArray of objects(ValueParam)

List of administrative areas.

thoroughfaresArray of objects(ThoroughfareParam)

List of thoroughfares.

postCodeobject(ValueParam)

Parameters for different kind of concept.

pageinteger(schemas-Page)>= 0

Current page number.

Default 0
Example: "1"
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page. Default 10.

Example: "10"
featureOnArray of strings

List of features to be activated.

Items ValueDescription
SWITCH_OFF_DATA_CURATION

Switch off data curation.

Example: ["SWITCH_OFF_DATA_CURATION"]
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/addresses/lookup \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "search": "Zurich",
    "country": {
      "shortName": "CH"
    },
    "groupBy": "LOCALITY",
    "localities": [
      {
        "value": "Concept name or value"
      }
    ],
    "administrativeAreas": [
      {
        "value": "Concept name or value"
      }
    ],
    "thoroughfares": [
      {
        "value": "Lukasstraße 4",
        "number": "4"
      }
    ],
    "postCode": {
      "value": "Concept name or value"
    },
    "page": "1",
    "pageSize": "10",
    "featureOn": [
      "SWITCH_OFF_DATA_CURATION"
    ]
  }'

Responses

OK

Bodyapplication/json
pagenumber

Current page number.

Example: "1"
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page. Default 10.

Example: "10"
pagesnumber

Number of pages.

Example: "50"
totalnumber

Total number of items which can be paged.

Example: "67"
valuesArray of objects(Address)

List of addresses.

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

Address String Categorization

Request

Set Values in Correct Buckets from Address String Based on Reference Data.

Security
basicAuth
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired
addressStringstring

Address string to be identified.

Example: "CDQ AG, Wiesenstrasse 10, 8952 Schlieren, Switzerland"
outputLanguageTechnicalKeystring(LanguageTechnicalKey)

ISO 639-1 two-letter code of languages.

Example: "DE"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/kr/addresses/identify \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "addressString": "CDQ AG, Wiesenstrasse 10, 8952 Schlieren, Switzerland",
    "outputLanguageTechnicalKey": "DE"
  }'

Responses

OK

Bodyapplication/json
addressStringstring

Address string to be identified.

Example: "CDQ AG, Wiesenstrasse 10, 8952 Schlieren, Switzerland"
outputLanguageTechnicalKeystring(LanguageTechnicalKey)

ISO 639-1 two-letter code of languages.

Example: "DE"
addressobject(Address)

An address provides information about the physical location of a Business Partner. It can be specialized in a certain context(e.g. delivery address or invoice address).

Response
application/json
{
  "addressString": "CDQ AG, Wiesenstrasse 10, 8952 Schlieren, Switzerland",
  "outputLanguageTechnicalKey": "DE",
  "address": {
    "version": { … },
    "identifyingName": { … },
    "externalId": "1",
    "metadata": { … },
    "careOf": { … },
    "contexts": [ … ],
    "country": { … },
    "administrativeAreas": [ … ],
    "postCodes": [ … ],
    "localities": [ … ],
    "thoroughfares": [ … ],
    "premises": [ … ],
    "postalDeliveryPoints": [ … ],
    "geographicCoordinates": { … },
    "types": [ … ],
    "formattedAddress": { … }
  }
}

Bulk Fetch

Operations

Bulk Lookup

Operations

Cancel Bulk

Operations

CEDEX Lookup

Operations

Batch Lookup

Operations

Batch Lookup Result

Operations

Administrative Area Index

Operations

DNB

Operations

Configurations

Operations

Processing Logs

Operations