Simplified Lookup Business Partners

Perform a comprehensive Business Partner lookup across all accessible Data Sources. This endpoint offers a simplified HTTP GET method for conducting the lookup. However, it only offers a limited set of default features. For the complete range of features, it is recommended to utilize the HTTP POST version.

SecurityapiKey
Request
query Parameters
country
string

The country (ISO code) of the Business Partner address.

Example: country=CH
identifier
string

An identifier (the value, number, payload) of the Business Partner.

Example: identifier=CHCHE218608886
identifierType
string

The type of given identifier of the Business Partner.

Example: identifierType=BVD_ID
locality
string

The locality (city) of the Business Partner address.

Example: locality=Sankt Gallen
name
string

The name of the Business Partner.

Example: name=CDQ
postCode
string

The postal code of the Business Partner address.

Example: postCode=9000
thoroughfare
string

The thoroughfare (street, incl. house number) of the Business Partner address.

Example: thoroughfare=Lukasstrasse 4
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/v3/businesspartners/lookup
Request samples
Response samples
application/json
{
  • "total": "67",
  • "limit": "100",
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "values": [
    ],
  • "goldenRecord": {
    },
  • "debugInfo": {
    },
  • "annotations": [
    ]
}