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

List Batch Lookup Results

Request

Read lookup job results by page.

Security
basicAuth
Path
idstringrequired

ID of the lookup job.

Example: cbed7ac6-a97d-4c23-9060-2a88fa660957
Query
businessPartnerIdArray of strings(BusinessPartnerId)

Business Partner IDs which should be filtered.

Example: businessPartnerId=63e635235c06b7396330fe40
startAfterstring

Pagination cursor which should be filled with nextStartAfter value provided in the previous page read response.

Default "0"
Example: startAfter=16
limitinteger(int32)[ 1 .. 1000 ]

Number of items to be returned on the page.

Default 100
Example: limit=20
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
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/lookupjobs/cbed7ac6-a97d-4c23-9060-2a88fa660957/results \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
limitinteger(Limit)

Number of items per page.

Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
valuesArray of objects(LookupJobResult)

List of lookup job results.

Response
application/json
{
  "startAfter": "5712566172571652",
  "limit": "100",
  "total": "67",
  "values": [
    { … }
  ]
}

List Batch Lookup Results

Request

Reads the results of a batch lookup job. The results are returned in pages. The page size can be controlled by the limit parameter. The results are sorted by the CDQ ID of the Business Partner.

Security
basicAuth
Path
idstringrequired

ID of the lookup job.

Example: cbed7ac6-a97d-4c23-9060-2a88fa660957
Query
businessPartnerIdArray of strings(BusinessPartnerId)

Business Partner IDs which should be filtered.

Example: businessPartnerId=63e635235c06b7396330fe40
startAfterstring

Pagination cursor which should be filled with nextStartAfter value provided in the previous page read response.

Default "0"
Example: startAfter=16
limitinteger(int32)[ 1 .. 1000 ]

Number of items to be returned on the page.

Default 100
Example: limit=20
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
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/v3/lookupjobs/cbed7ac6-a97d-4c23-9060-2a88fa660957/results \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
limitinteger(Limit)

Number of items per page.

Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
valuesArray of objects(LookupJobResult)

List of lookup job results.

Response
application/json
{
  "startAfter": "5712566172571652",
  "limit": "100",
  "total": "67",
  "values": [
    { … }
  ]
}

Administrative Area Index

Operations

DNB

Operations

Configurations

Operations

Processing Logs

Operations