Skip to content

Data Curation API (3)

This API provides services to curate and enrich Business Partner and address data.

Address Curation
Download OpenAPI description
api-v3.json
api-v3.yaml
Overview
URL

https://www.cdq.ch/team

Sylwester Lew

sylwester.lew@cdq.com

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/data-curation-api/api-v3/

Production SOAP

https://api.cdq.com/data-curation/soap/v3/

Production

https://api.cdq.com/data-curation/

Batch Curation

Everything about Batch Curation

Operations

Business Partners

Everything about Business Partners

Operations

Processing Logs

Operations

Configuration

Operations

Cache

Operations

Addresses

Operations

Returns Formatted Address

Request

Takes an address as input and provides a standardized and properly formatted version of the address as output.

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
addressobject(AddressRequest)required

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). Additional documentation can be found here.

address.​versionobject(AddressVersion)

CDQ supports multiple versions of addresses comprising different charsets and languages. An address version is a unique combination of a character set and a language.

address.​identifyingNameobject(AddressIdentifyingNameRequest)

An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent.

address.​externalIdstring(AddressExternalId)

ID the address has in the external system where the record originates from.

Example: "1"
address.​careOfobject(CareOfRequest)

Signifies an intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example, when the addressee has no standard address, is under a corporate mail system, or is being manually forwarded mail sent to a more accessible location.

address.​contextsArray of objects(AddressContextRequest)

List of Address Contexts.

address.​countryobject(CountryRequest)

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

address.​administrativeAreasArray of objects(AdministrativeAreaRequest)

List of Administrative Areas.

address.​postCodesArray of objects(PostCodeRequest)

List of additional Post Codes.

address.​localitiesArray of objects(LocalityRequest)

List of Localities.

address.​thoroughfaresArray of objects(ThoroughfareRequest)

List of Thoroughfares.

address.​premisesArray of objects(PremiseRequest)

List of Premises.

address.​postalDeliveryPointsArray of objects(PostalDeliveryPointRequest)

List of Postal Delivery Points.

address.​geographicCoordinatesobject(GeographicCoordinatesRequest)

Decimal geographic coordinates (WGS 84 - reference coordinate system). Additional documentation can be found here.

address.​typesArray of objects(AddressTypeRequest)

List of Address Types.

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-curation-api/api-v3/v2/addresses/format \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "address": {
      "version": {
        "characterSet": {
          "name": "International",
          "technicalKey": "INTERNATIONAL"
        },
        "language": {
          "name": "German",
          "technicalKey": "DE"
        }
      },
      "identifyingName": {
        "value": "John Doe"
      },
      "externalId": "1",
      "careOf": {
        "value": "CDQ GmbH c/o Product Department"
      },
      "contexts": [
        {
          "value": "Production hall 7, Storage field 8."
        }
      ],
      "country": {
        "shortName": "CH",
        "value": "Switzerland"
      },
      "administrativeAreas": [
        {
          "value": "Sankt Gallen",
          "fipsCode": "SZ15",
          "isoCode": "CH-SG",
          "shortName": "SG",
          "type": {
            "name": "COUNTY",
            "url": "https://meta.cdq.com/Address/administrative_area/type",
            "technicalKey": "COUNTY"
          },
          "language": {
            "name": "German",
            "technicalKey": "DE"
          }
        }
      ],
      "postCodes": [
        {
          "value": "9000",
          "type": {
            "name": "Regular",
            "url": "https://meta.cdq.com/Address/post_code/type",
            "technicalKey": "REGULAR"
          }
        }
      ],
      "localities": [
        {
          "type": {
            "name": "City",
            "url": "https://meta.cdq.com/Address/locality/type",
            "technicalKey": "CITY"
          },
          "shortName": "St. Gallen",
          "value": "Sankt Gallen",
          "language": {
            "name": "German",
            "technicalKey": "DE"
          }
        }
      ],
      "thoroughfares": [
        {
          "type": {
            "name": "Industrial zone",
            "url": "https://meta.cdq.com/Address/thoroughfare/type",
            "technicalKey": "INDUSTRIAL_ZONE"
          },
          "shortName": "Lukasstr. 4",
          "number": "4",
          "value": "Lukasstraße 4",
          "name": "Lukasstraße",
          "direction": "221-bis Baker Street, North",
          "language": {
            "name": "German",
            "technicalKey": "DE"
          }
        }
      ],
      "premises": [
        {
          "value": "Lukasstraße 4",
          "shortName": "Lukasstr. 4",
          "number": "4",
          "type": {
            "name": "Factory",
            "url": "https://meta.cdq.com/Address/premise/type",
            "technicalKey": "FACTORY"
          },
          "language": {
            "name": "German",
            "technicalKey": "DE"
          }
        }
      ],
      "postalDeliveryPoints": [
        {
          "type": {
            "name": "Mailbox",
            "url": "https://meta.cdq.com/Address/postal_delivery_point/type",
            "technicalKey": "MAILBOX"
          },
          "shortName": "St Gallen, Postfach 460",
          "number": "460",
          "value": "Postfach",
          "language": {
            "name": "German",
            "technicalKey": "DE"
          }
        }
      ],
      "geographicCoordinates": {
        "latitude": "47.439549",
        "longitude": "9.395275"
      },
      "types": [
        {
          "name": "Legal Address",
          "url": "https://meta.cdq.com/Address/type",
          "technicalKey": "LEGAL_ADDRESS"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
formattedAddressobject(schemas-FormattedAddress)

A formatted address is a structured address of VIES data source.

Response
application/json
{
  "formattedAddress": {
    "country": "Switzerland",
    "administrativeArea": "Sankt Gallen",
    "region": "Sankt Gallen",
    "regionCode": "9004",
    "locality": "Sankt Gallen",
    "district": "City center",
    "postalCode": "9000",
    "thoroughfare": "Lukassstrasse",
    "premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
    "interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
    "mailbox": "Postfach 460",
    "postOfficeBox": "Postfach 460"
  }
}

Parse String Address

Request

Takes a string as input and returns a structured representation of the address.

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
countryShortNamestring(CountryShortName)

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

Example: "CH"
addressStringstringrequired

Address to parse.

Example: "Musterstraße 1, 12345 Musterstadt"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-curation-api/api-v3/v2/addresses/parse \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "countryShortName": "CH",
    "addressString": "Musterstraße 1, 12345 Musterstadt"
  }'

Responses

OK

Bodyapplication/json
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). Additional documentation can be found here.

Response
application/json
{
  "address": {
    "version": { … },
    "identifyingName": { … },
    "externalId": "1",
    "careOf": { … },
    "contexts": [ … ],
    "country": { … },
    "administrativeAreas": [ … ],
    "postCodes": [ … ],
    "localities": [ … ],
    "thoroughfares": [ … ],
    "premises": [ … ],
    "postalDeliveryPoints": [ … ],
    "geographicCoordinates": { … },
    "types": [ … ]
  }
}