# Lookup Business Partners

Lookup a business partner in all available data sources.

Endpoint: POST /referencedata/restv3/businesspartners/lookup
Version: 1
Security: apiKey

## Request fields (application/json):

  - `name` (string)
    Name of the Business Partner.
    Example: "CDQ AG"

  - `identifierType` (string)
    Identifier type of the Business Partner.
    Example: "EU_VAT_ID_DE"

  - `identifierValue` (string)
    Identifier value of the Business Partner.
    Example: "DE123456789"

  - `country` (string)
    Country of the Business Partner.
    Example: "DE"

  - `city` (string)
    City of the Business Partner.
    Example: "Hamburg"

  - `postCode` (string)
    Post code of the Business Partner.
    Example: "20095"

  - `street` (string)
    Street of the Business Partner.
    Example: "Jungfernstieg"

  - `houseNo` (string)
    House number of the Business Partner.
    Example: "4"

  - `matchingThreshold` (number)
    Matching threshold for the Business Partner.
    Example: "0.5"

  - `maxCandidates` (integer)
    Maximum number of candidates to return. Default is 50.
    Example: "50"

  - `pageSize` (integer)
    Number of items per page.
    Example: "10"

  - `page` (integer)
    Current page number.
    Example: "0"

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

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

## Response 200 fields (application/json):

  - `pageSize` (integer)
    Number of items per page.
    Example: "10"

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

  - `page` (integer)
    Current page number.
    Example: "0"

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

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

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

  - `businessPartnerCandidates` (array)
    List of Business Partner candidates.

  - `businessPartnerCandidates.cdqId` (string)
    CDQ ID of the Business Partner.
    Example: "cdq:businesspartner:cdqId:DE:123456789"

  - `businessPartnerCandidates.dataSource` (string)
    Unique identifier for a Data Source of the Storage.
    Example: "648824a691d8d2503d65103e"

  - `businessPartnerCandidates.matchingScore` (number)
    Matching score of the Business Partner.
    Example: "0.5"

  - `businessPartnerCandidates.matchingClassification` (string)
    Matching classification of the Business Partner.
    Example: "DUPLICATE"

  - `businessPartnerCandidates.name` (string)
    Name of the Business Partner.
    Example: "CDQ AG"

  - `businessPartnerCandidates.legalForm` (string)
    Legal form of the Business Partner.
    Example: "AG"

  - `businessPartnerCandidates.status` (string)
    Status of the Business Partner.
    Example: "ACTIVE"

  - `businessPartnerCandidates.identifiers` (array)
    List of identifiers of the Business Partner.

  - `businessPartnerCandidates.identifiers.identifierType` (string)
    Identifier type of the Business Partner.
    Example: "EU_VAT_ID_DE"

  - `businessPartnerCandidates.identifiers.identifierValue` (string)
    Identifier value of the Business Partner.
    Example: "DE123456789"

  - `businessPartnerCandidates.addresses` (array)
    List of addresses of the Business Partner.

  - `businessPartnerCandidates.addresses.country` (string)
    Country of the address.
    Example: "DE"

  - `businessPartnerCandidates.addresses.countryName` (string)
    Country name of the address.
    Example: "Germany"

  - `businessPartnerCandidates.addresses.region` (string)
    Region of the address.
    Example: "DE-BW"

  - `businessPartnerCandidates.addresses.regionName` (string)
    Region name of the address.
    Example: "Baden-Württemberg"

  - `businessPartnerCandidates.addresses.city` (string)
    City of the address.
    Example: "Stuttgart"

  - `businessPartnerCandidates.addresses.postCode` (string)
    Post code of the address.
    Example: "70173"

  - `businessPartnerCandidates.addresses.street` (string)
    Street of the address.
    Example: "Königstraße"

  - `businessPartnerCandidates.addresses.houseNo` (string)
    House number of the address.
    Example: "10"

  - `businessPartnerCandidates.addresses.building` (string)
    Building of the address.
    Example: "Dorotheen Quartier"

  - `businessPartnerCandidates.addresses.floor` (string)
    Floor of the address.
    Example: "3"

  - `businessPartnerCandidates.addresses.room` (string)
    Room of the address.
    Example: "14"

  - `businessPartnerCandidates.addresses.latitude` (number)
    Latitude of the address.
    Example: "48.778"

  - `businessPartnerCandidates.addresses.longitude` (number)
    Longitude of the address.
    Example: "9.179"