# Fetch Business Partner Relations

Retrieves the Business Partner Relations based on the Lookup and returning the result of the single record.

Endpoint: POST /v3/businesspartners/fetchrelations
Version: 3
Security: apiKey

## Request fields (application/json):

  - `cdqId` (string)
    CDQ ID for Business Partner and address.
    Example: "VIES:DE123456789"

  - `limit` (integer)
    Number of items per page.
    Example: "100"

  - `startAfter` (string)
    The ID which is used to read the page.
    Example: "5712566172571652"

  - `endedAfter` (string)
    Find relations which endedAt is after given date.
    Example: "2025-09-12T14:57:59Z"

  - `endedBefore` (string)
    Find relations which endedAt is before given date.
    Example: "2025-09-12T14:57:59Z"

  - `startedAfter` (string)
    Find relations which startedAt is after given date.
    Example: "2025-09-12T14:57:59Z"

  - `startedBefore` (string)
    Find relations which startedAt is before given date.
    Example: "2025-09-12T14:57:59Z"

  - `classTechnicalKey` (string)
    Filter by class technical key.
    Example: "BUSINESS_PARTNER_RELATION_CLASS_LEI_HIERARCHY"

  - `typeTechnicalKey` (string)
    Filter by type.
    Example: "LEI_DIRECT_PARENT"

## Response 200 fields (application/json):

  - `nextStartAfter` (string)
    Provides a value to be used as a startAfter in next page request.
    Example: "5712566172571652"

  - `limit` (integer)
    Number of items per page.
    Example: "100"

  - `total` (integer)
    Total number of items which can be paged.
    Example: "67"

  - `values` (array)
    List of Business Partner relations.

  - `values.startedAt` (string)
    Describe when this relationship was first established.
    Example: "2025-09-12T14:57:59Z"

  - `values.endedAt` (string)
    Describe when this relationship ended.
    Example: "2025-09-12T14:57:59Z"

  - `values.type` (object)
    Provides information about the type of the relationship between two Business Partners like:\ direct parent/child, ultimate parent, branch.

  - `values.type.name` (string)
    Display name of the Business Partner Relation Type.
    Example: "Commercial ultimate"

  - `values.type.url` (string)
    URL to the documentation which summarizes all details of a [Business Partner Relation Type](https://meta.cdq.com/Business_partner/relation/type).
    Example: "https://meta.cdq.com/Business_partner/relation/type"

  - `values.type.technicalKey` (string)
    Technical Key of the Business Partner Relation Type.
    Example: "COMMERCIAL_ULTIMATE"

  - `values.class` (object)
    Provides information about the classification of the relation.

  - `values.class.name` (string)
    Display name of the Business Partner Relation Class.
    Example: "CDQ Hierarchy"

  - `values.class.url` (string)
    URL to the documentation which summarizes all details of a [Business Partner Relation Class](https://meta.cdq.com/Business_partner/relation/class).
    Example: "https://meta.cdq.com/Business_partner/relation/class"

  - `values.class.technicalKey` (string)
    Technical Key of the Business Partner Relation Class.
    Example: "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"

  - `values.startNode` (string)
    It's a number of the business partner that plays a superior role over the other business partner. In means that, the company is parent of the second company (child) and has one of the relationship type like:\ Domestic Ultimate Legal entity or Direct Legal entity.
    Example: "FR.RC:5664645"

  - `values.endNode` (string)
    It's a number of the business partner that plays a subordinate role over the other business partner. In means that, the company is chile of the second company (parent) and has one of the special relationship types.
    Example: "FR.RC:5664645"

  - `values.startNodeBusinessPartner` (object)
    Relation of the Business Partner.

  - `values.startNodeBusinessPartner.names` (array)
    List of names.

  - `values.startNodeBusinessPartner.names.shortName` (string)
    The abbreviated variant of a company's full name.
    Example: "CDQ AG"

  - `values.startNodeBusinessPartner.names.type` (object)
    The type of the name, e.g. a locally used name or an international version. Allowed types are documented [here](https://meta.cdq.com/Business_partner/name/type).

  - `values.startNodeBusinessPartner.names.type.url` (string)
    URL to the documentation which summarizes all details of the [Name Type](https://meta.cdq.com/Business_partner/name/type).
    Example: "https://meta.cdq.com/Business_partner/name/type"

  - `values.startNodeBusinessPartner.names.type.name` (string)
    Display label for the Name Type.
    Example: "Local Name"

  - `values.startNodeBusinessPartner.names.type.technicalKey` (string)
    Technical Keys of the Name Type.
    Example: "LOCAL"

  - `values.startNodeBusinessPartner.names.value` (string)
    The actual name.
    Example: "Corporate Data Quality AG"

  - `values.startNodeBusinessPartner.names.language` (object)
    Naming of a language according to ISO 639-1.

  - `values.startNodeBusinessPartner.names.language.name` (string)
    ISO 639-1 name of language.
    Example: "German"

  - `values.startNodeBusinessPartner.names.language.technicalKey` (string)
    ISO 639-1 two-letter code of languages.
    Example: "DE"

  - `values.startNodeBusinessPartner.names.details` (array)

  - `values.startNodeBusinessPartner.names.details.value` (string)
    Value of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name).
    Example: "Corporate Data Quality AG - Marketing Department"

  - `values.startNodeBusinessPartner.names.details.type` (object)
    Type of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name).

  - `values.startNodeBusinessPartner.names.details.type.name` (string)
    Name Detail Type Name of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name).
    Example: "Legal Entity"

  - `values.startNodeBusinessPartner.names.details.type.url` (string)
    Name Detail Type Url of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name).
    Example: "https://meta.cdq.com/Business_partner/type"

  - `values.startNodeBusinessPartner.names.details.type.technicalKey` (string)
    Name Detail Type Technical Key of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name).
    Example: "LEGAL_ENTITY"

  - `values.startNodeBusinessPartner.addresses` (array)
    List of addresses.

  - `values.startNodeBusinessPartner.addresses.country` (object)
    Country consisting of the country name and country code (ISO 3166-1 alpha-2).

  - `values.startNodeBusinessPartner.addresses.country.shortName` (string)
    Country code (ISO 3166-1 alpha-2).
    Example: "CH"

  - `values.startNodeBusinessPartner.addresses.country.value` (string)
    Country name (ISO 3166-1 alpha-2).
    Example: "Switzerland"

  - `values.startNodeBusinessPartner.addresses.postCodes` (array)
    List of Post Codes.

  - `values.startNodeBusinessPartner.addresses.postCodes.value` (string)
    Effective [post code](https://meta.cdq.com/Address/post_code).
    Example: "9000"

  - `values.startNodeBusinessPartner.addresses.postCodes.type` (object)
    Type of the Post Code.

  - `values.startNodeBusinessPartner.addresses.postCodes.type.name` (string)
    Display label for the Post Code Type.
    Example: "Regular"

  - `values.startNodeBusinessPartner.addresses.postCodes.type.url` (string)
    URL to the documentation which summarizes all details of the [Administrative Area](https://meta.cdq.com/Address/post_code/type).
    Example: "https://meta.cdq.com/Address/post_code/type"

  - `values.startNodeBusinessPartner.addresses.postCodes.type.technicalKey` (string)
    Technical key of the Post Code.
    Example: "REGULAR"

  - `values.startNodeBusinessPartner.addresses.localities` (array)
    List of Localities.

  - `values.startNodeBusinessPartner.addresses.localities.type` (object)
    Type of the [Locality](https://meta.cdq.com/Address/locality).

  - `values.startNodeBusinessPartner.addresses.localities.type.name` (string)
    Display label for the Locality Type.
    Example: "City"

  - `values.startNodeBusinessPartner.addresses.localities.type.url` (string)
    URL to the documentation which summarizes all details of the [Locality Type](https://meta.cdq.com/Address/locality/type).
    Example: "https://meta.cdq.com/Address/locality/type"

  - `values.startNodeBusinessPartner.addresses.localities.type.technicalKey` (string)
    Technical Key of the Locality Type.
    Example: "CITY"

  - `values.startNodeBusinessPartner.addresses.localities.shortName` (string)
    Abbreviation of the [Locality](https://meta.cdq.com/Address/locality).
    Example: "St. Gallen"

  - `values.startNodeBusinessPartner.addresses.localities.value` (string)
    Name of the [Locality](https://meta.cdq.com/Address/locality).
    Example: "Sankt Gallen"

  - `values.startNodeBusinessPartner.addresses.thoroughfares` (array)
    List of Thoroughfares.

  - `values.startNodeBusinessPartner.addresses.thoroughfares.type` (object)
    Type of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).

  - `values.startNodeBusinessPartner.addresses.thoroughfares.type.name` (string)
    Display label for the Thoroughfare Type Name.
    Example: "Industrial zone"

  - `values.startNodeBusinessPartner.addresses.thoroughfares.type.url` (string)
    URL to the documentation which summarizes all details of the [Thoroughfare Type](https://meta.cdq.com/Address/thoroughfare/type).
    Example: "https://meta.cdq.com/Address/thoroughfare/type"

  - `values.startNodeBusinessPartner.addresses.thoroughfares.type.technicalKey` (string)
    Technical key of the Thoroughfare Type.
    Example: "INDUSTRIAL_ZONE"

  - `values.startNodeBusinessPartner.addresses.thoroughfares.shortName` (string)
    Abbreviation of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
    Example: "Lukasstr. 4"

  - `values.startNodeBusinessPartner.addresses.thoroughfares.number` (string)
    Number of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
    Example: "4"

  - `values.startNodeBusinessPartner.addresses.thoroughfares.value` (string)
    Comprehensive designation of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) including the thoroughfare type such as Street, or Rue.
    Example: "Lukasstraße 4"

  - `values.startNodeBusinessPartner.addresses.thoroughfares.name` (string)
    Pure name of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) not comprising the thoroughfare type such as Street, or Rue.
    Example: "Lukasstraße"

  - `values.startNodeBusinessPartner.addresses.thoroughfares.direction` (string)
    Direction of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
    Example: "221-bis Baker Street, North"

  - `values.endNodeBusinessPartner` (object)
    Relation of the Business Partner.