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

Search Cedex Code

Request

Allows searching by Cedex and finding Cedex code for given post codes.

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
pageinteger(schemas-Page)>= 0

Current page number.

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

Number of items per page. Default 10.

Example: "10"
cedexstring

System used in France for the delivery of mail to business customers with a large volume of incoming mail.

Example: "64205 CEDEX"
regularPostCodestring

Regular post code.

Example: "64200"
localitystring

Locality.

Example: "Biarritz"
siretstring

Unique identifier for a business entity in France.

Example: "732 829 320"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/frrc/cedex/lookup \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "page": "1",
    "pageSize": "10",
    "cedex": "64205 CEDEX",
    "regularPostCode": "64200",
    "locality": "Biarritz",
    "siret": "732 829 320"
  }'

Responses

OK

Bodyapplication/json
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page. Default 10.

Example: "10"
totalsinteger(int64)

Total number of records.

Example: "100"
pageinteger(schemas-Page)>= 0

Current page number.

Default 0
Example: "1"
valuesArray of objects(FrRcCedexLookupMatch)

List of FrRcCedex Lookup Matches.

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

Batch Lookup

Operations

Batch Lookup Result

Operations

Administrative Area Index

Operations

DNB

Operations

Configurations

Operations

Processing Logs

Operations