# Read DNB Lookup Job results

Reads the results of a DNB lookup job by job ID.

Endpoint: GET /dnb/lookupjobs/{id}/results
Version: 3
Security: apiKey

## Path parameters:

  - `id` (string, required)
    ID of the lookup job.
    Example: "cbed7ac6-a97d-4c23-9060-2a88fa660957"

## Query parameters:

  - `businessPartnerId` (array)
    Business Partner IDs which should be filtered.
    Example: ["63e635235c06b7396330fe40"]

  - `startAfter` (string)
    Only records with an ID greater than this ID will be fetched.
    Example: "5712566172571652"

  - `limit` (integer)
    Number of results that should be fetched. Maximum 100 results can be returned in one page.
    Example: "50"

## Response 200 fields (application/json):

  - `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"

  - `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 DNB Lookup Job results.

  - `values.id` (string)
    Unique identifier of a job.
    Example: "35f23c03-1c22-45fe-9484-3ffe769325de"

  - `values.businessPartnerId` (string)
    A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League.
    Example: "63e635235c06b7396330fe40"

  - `values.addressId` (string)
    Address ID of the Business Partner.
    Example: "0"

  - `values.externalId` (string)
    Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.
    Example: "The ID managed in the customer's SAP systems."

  - `values.requestData` (object)
    Contains the request data of a DNB Lookup Job match.

  - `values.requestData.nameLocal` (string)
    Local name of the Business Partner.
    Example: "CDQ"

  - `values.requestData.nameInternational` (string)
    International name of the Business Partner.
    Example: "CDQ AG"

  - `values.requestData.countryValue` (string)
    Country name (ISO 3166-1 alpha-2).
    Example: "Switzerland"

  - `values.requestData.countryShortName` (string)
    Country code (ISO 3166-1 alpha-2).
    Example: "CH"

  - `values.requestData.administrativeArea` (string)
    Name of the [Administrative Area](https://meta.cdq.com/Address/administrative_area).
    Example: "Sankt Gallen"

  - `values.requestData.postCodeValue` (string)
    Effective [post code](https://meta.cdq.com/Address/post_code).
    Example: "9000"

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

  - `values.requestData.thoroughfareValue` (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.requestData.thoroughfareNumber` (string)
    Number of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
    Example: "4"

  - `values.requestData.premiseValue` (string)
    The actual value of a Premise in the language of the address.
    Example: "Lukasstraße 4"

  - `values.requestData.classificationCode` (string)
    Code that classifies the business partner.
    Example: "20.20Z"

  - `values.requestData.classificationTypeName` (string)
    Display label for the Classification Type.
    Example: "NAF 2003"

  - `values.requestData.classificationName` (string)
    A textual description of the Classification.
    Example: "Manufacture of pesticides and other agrochemical products."

  - `values.requestData.careOf` (string)
    Value of the CareOf.
    Example: "CDQ GmbH c/o Product Department"

  - `values.requestData.addressTypes` (string)
    Technical key of the Address Type.
    Example: "LEGAL_ADDRESS"

  - `values.requestData.isInactive` (string)
    Indicates whether the Business Partner is inactive.
    Example: "Inactive"

  - `values.requestData.stceg` (string)
    VAT registration number.
    Example: "CHE-218.608.88"

  - `values.requestData.stcd1` (string)
    Standard tax number field1.
    Example: "CHE-218.608.88"

  - `values.requestData.stcd2` (string)
    Standard tax number field2.
    Example: "CHE-218.608.88"

  - `values.requestData.stcd3` (string)
    Standard tax number field3.
    Example: "CHE-218.608.88"

  - `values.requestData.stcd4` (string)
    Standard tax number field4.
    Example: "CHE-218.608.88"

  - `values.requestData.stcd5` (string)
    Standard tax number field5.
    Example: "CHE-218.608.88"

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

  - `values.requestData.duns` (string)
    DUNS number of the record to be fetched.
    Example: "15-048-3782"

  - `values.matchResults` (array)
    List of DNB Lookup Job match results.

  - `values.matchResults.candidate` (object)
    Details of Business Partner in D&B Model.

  - `values.matchResults.candidate.displaySequence` (integer)
    The order in which the entity appears in the result set. The lower the number the better the probability of the match.
    Example: "1"

  - `values.matchResults.candidate.organization` (object)
    The details of the entity.

  - `values.matchResults.candidate.organization.duns` (string)
    The D-U-N-S Number, assigned by Dun & Bradstreet, is an identification number that uniquely identifies the entity in accordance with the Data Universal Numbering System (D-U-N-S).
    Example: "804735132"

  - `values.matchResults.candidate.organization.dunsControlStatus` (object)
    The details of the entity established to provide products and/or services in the marketplace or to the community.

  - `values.matchResults.candidate.organization.dunsControlStatus.operatingStatus` (object)
    The details of the entity's functional state or trading status.

  - `values.matchResults.candidate.organization.dunsControlStatus.operatingStatus.description` (string)
    The entity''s functional state or trading status (e.g., active, out of business).
    Example: "Active"

  - `values.matchResults.candidate.organization.dunsControlStatus.operatingStatus.dnbCode` (integer)
    A unique code assigned by Dun & Bradstreet to identify the entity's functional state or trading status.
    Example: "9074"

  - `values.matchResults.candidate.organization.dunsControlStatus.isMailUndeliverable` (boolean)
    Indicates whether it is possible to deliver mail to the address of this entity.- If true, it is not possible to deliver mail to the address.- If false, it is possible to deliver mail to the address.
    Example: "false"

  - `values.matchResults.candidate.organization.primaryName` (string)
    The single name by which the entity is primarily known or identified.
    Example: "GORMAN MANUFACTURING COMPANY, INC."

  - `values.matchResults.candidate.organization.tradeStyleNames` (array)
    The details of the names that the entity trades under for commercial purposes although its registered legal name used for contracts and other formal situations may be another name.

  - `values.matchResults.candidate.organization.tradeStyleNames.name` (string)
    The name that the entity trades under for commercial purposes  although its registered legal name used for contracts and other formal situations may be another name.
    Example: "Alternate Company Name"

  - `values.matchResults.candidate.organization.tradeStyleNames.priority` (integer)
    The sequence in which the entity mostly uses this tradestyle name.
    Example: "1"

  - `values.matchResults.candidate.organization.telephone` (array)
    The details of the telephone information used for voice communication with the entity.

  - `values.matchResults.candidate.organization.telephone.telephoneNumber` (string)
    A sequence of digits used for voice communication with the entity.This sequence of digits includes the area code or city code and domestic dialing code.
    Example: "6505550000"

  - `values.matchResults.candidate.organization.telephone.isUnreachable` (boolean)
    Indicates whether the telephone number can be connected to successfully.- If true, connection to the  telephone number is unsuccessful.- If false, connection to the  telephone number is successful.
    Example: "false"

  - `values.matchResults.candidate.organization.websiteAddress` (array)
    The details of the internet URLs used for online information and communication with the entity.

  - `values.matchResults.candidate.organization.websiteAddress.url` (string)
    The Internet URL (Uniform Resource Locator) that uniquely identifies the proprietary website of the entity or the website preferred by the entity that gives more information on the entity.
    Example: "http://www.gorman.com"

  - `values.matchResults.candidate.organization.websiteAddress.domainName` (string)
    A unique name used to identify the website of the entity that serves as an address to access that website.
    Example: "gorman.com"

  - `values.matchResults.candidate.organization.primaryAddress` (object)
    The details of the single primary or physical address at which the entity is located.

  - `values.matchResults.candidate.organization.primaryAddress.addressCountry` (object)
    The details of the country in which this address is located.

  - `values.matchResults.candidate.organization.primaryAddress.addressCountry.isoAlpha2Code` (string)
    The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country in which this address is located.
    Example: "US"

  - `values.matchResults.candidate.organization.primaryAddress.addressCountry.name` (string)
    The name of the country in which this address is located.
    Example: "United States"

  - `values.matchResults.candidate.organization.primaryAddress.addressLocality` (object)
    The details of the city, town, township, village, borough, etc. in which this address is located.

  - `values.matchResults.candidate.organization.primaryAddress.addressLocality.name` (string)
    The name of the city, town, township, village, borough, etc. in which this address is located.
    Example: "SAN FRANCISCO"

  - `values.matchResults.candidate.organization.primaryAddress.addressRegion` (object)
    The details of the locally governed area that forms part of a centrally governed nation to identify where this address is located.

  - `values.matchResults.candidate.organization.primaryAddress.addressRegion.abbreviatedName` (string)
    The shortened name of the locally governed area that forms part of a centrally governed nation. For example 'NJ' for the US State New Jersey within Country United States.
    Example: "CA"

  - `values.matchResults.candidate.organization.primaryAddress.postalCode` (string)
    An identifier used by the local country's postal authority to identify where this address is located.
    Example: "941109999"

  - `values.matchResults.candidate.organization.primaryAddress.postalCodeExtension` (string)
    An extension to the postal code that identifies a street or building within the geographic area covered by the Postal Code.
    Example: "9999"

  - `values.matchResults.candidate.organization.primaryAddress.streetAddress` (object)
    The details of the street address where the entity is located.

  - `values.matchResults.candidate.organization.primaryAddress.streetAddress.line1` (string)
    The first line of the address where the entity is located.For example, "41 Central Chambers" in the address 41 Central ChambersDame CourtDublin 2.
    Example: "492 KOLLER ST"

  - `values.matchResults.candidate.organization.primaryAddress.streetAddress.line2` (string)
    The second line of the address where the entity is located.For example, "Dame Court" in the address 41 Central ChambersDame CourtDublin 2.
    Example: "Suite 100"

  - `values.matchResults.candidate.organization.mailingAddress` (object)
    The details of the address used by the entity for mailing purposes.

  - `values.matchResults.candidate.organization.registrationNumbers` (array)
    The details of the numbers assigned by an external body or by Dun & Bradstreet that either uniquely identifies or helps to identify the entity.

  - `values.matchResults.candidate.organization.registrationNumbers.registrationNumber` (string)
    The number assigned by an external body or by Dun & Bradstreet that either uniquely identifies or helps to identify the entity.
    Example: "12-3456789"

  - `values.matchResults.candidate.organization.registrationNumbers.typeDescription` (string)
    The type of registration (e.g., Chamber of Commerce Number, Value Added Tax Number, Federal Taxpayer Identification Number, Companies Registry Office Number).
    Example: "Federal Taxpayer Identification Number (US)"

  - `values.matchResults.candidate.organization.registrationNumbers.typeDnBCode` (integer)
    A unique code assigned by Dun & Bradstreet to identify the type of registration number.
    Example: "6863"

  - `values.matchResults.candidate.organization.mostSeniorPrincipals` (array)
    The  details of the most important principals.

  - `values.matchResults.candidate.organization.mostSeniorPrincipals.fullName` (string)
    The complete name of the principal.
    Example: "Leslie Ann Smith"

  - `values.matchResults.candidate.organization.isStandalone` (boolean)
    Indicates if the entity is a member of a legal family tree. - If true, indicates that the entity is not a member of a legal family tree.  This means it cannot play any family tree role and corporateLinkage will not be present.- If false, indicates that the entity is a member of a legal family tree.  The roles it plays is indicated by Family Tree Member Roles played.
    Example: "false"

  - `values.matchResults.candidate.organization.corporateLinkage` (object)
    The details of the relationship between the entity and other entities in the legal family tree.

  - `values.matchResults.candidate.organization.corporateLinkage.familytreeRolesPlayed` (array)
    The details of the roles the entity plays as a member of an ownership structured family tree.

  - `values.matchResults.candidate.organization.corporateLinkage.familytreeRolesPlayed.description` (string)
    The role the entity plays as a member of an ownership structured family tree (e.g., a branch, division, a parent, headquarters, subsidiary, global ultimate, domestic ultimate).
    Example: "Parent/Headquarters"

  - `values.matchResults.candidate.organization.corporateLinkage.familytreeRolesPlayed.dnbCode` (integer)
    A unique code assigned by Dun & Bradstreet to identify describing family tree role.
    Example: "9141"

  - `values.matchResults.candidate.matchQualityInformation` (object)
    The details of the parameters and components assessed by the Match engine.

  - `values.matchResults.candidate.matchQualityInformation.confidenceCode` (integer)
    A numeric value from 1 (low) up to 10 (high) indicating the level of certainty at which this possible candidate was included in this result set.
    Example: "6"

  - `values.matchResults.candidate.matchQualityInformation.matchGrade` (string)
    The compound rating that comprises one rating per type of data scored by a match engine.  For example, in AABZBAAAFBZ the "A" in the 1st position means that the Name scored between 80-100 and the "A" in the 2nd position means that the Street Number had to score exactly 100.For more details, please see the Identity Resolution guide.
    Example: "AZZZZZZZFZZ"

  - `values.matchResults.candidate.matchQualityInformation.matchGradeComponentsCount` (integer)
    The number of constituent parts that were used in the calculation of the Match Grade.
    Example: "11"

  - `values.matchResults.candidate.matchQualityInformation.matchGradeComponents` (array)
    The details of the components measured by the match engine.

  - `values.matchResults.candidate.matchQualityInformation.matchGradeComponents.componentType` (string)
    The component (e.g., Name, Street Number) of the Match Grade that was measured by the match engine.
    Example: "Name"

  - `values.matchResults.candidate.matchQualityInformation.matchGradeComponents.componentRating` (string)
    The quality of the match result on this component.  The rating is based on a scoring system.
    Example: "A"

  - `values.matchResults.candidate.matchQualityInformation.matchDataProfile` (string)
    The information that the matching process used to arrive at a match in addition to the application''s business rules and parameters specified by the requestor. This is a 28-byte string consisting of 14 components of 2 bytes each. The 14 components are, in order, Name, Street Number, Street Name, Town Name, Territory Name, P.O. Box, Telephone, Post Code, D-U-N-S Number, Industry Code, Geographical Density, Location Uniqueness, Registration Number and URL.
    Example: "0000000000989800000000009898"

  - `values.matchResults.candidate.matchQualityInformation.matchDataProfileComponentsCount` (integer)
    The number of constituent parts (e.g., Name, Street Number) that were used in the calculation of the Match Data Profile.
    Example: "14"

  - `values.matchResults.candidate.matchQualityInformation.matchDataProfileComponents` (array)
    The details of the constituent parts (e.g., Name, Street Number) that were used in the calculation of the Match Data Profile.

  - `values.matchResults.candidate.matchQualityInformation.matchDataProfileComponents.componentType` (string)
    The specific component type used.
    Example: "Name"

  - `values.matchResults.candidate.matchQualityInformation.matchDataProfileComponents.componentValue` (string)
    The value of the component described in Match Data Profile Component Type.
    Example: "0"

  - `values.matchResults.candidate.matchQualityInformation.nameMatchScore` (number)
    A number from -1 to 100 (including decimals) that indicates the detailed level of match on the name of the matched candidate.- 0 indicates no match.- 100 indicates most accurate match.
    Example: "85.5"

  - `values.matchResults.matchingProfile` (object)
    Matching profile used for the match. It contains the matching threshold and the matching scores.

  - `values.matchResults.matchingProfile.matchingScores` (object)
    List of the numerical value of similarity between Business Partners or addresses enhanced with the overall score.

  - `values.matchResults.matchingProfile.matchingScores.overall` (object)
    Shows numerical value of similarity between Business Partners or address stored in the Data Mirror and the Business Partner from the request.

  - `values.matchResults.matchingProfile.matchingScores.overall.classification` (object)
    Classification of the matching score. It can be ,  or .

  - `values.matchResults.matchingProfile.matchingScores.overall.classification.technicalKey` (string)
    Technical key of the Matching Classification.
    Example: "HIGH"

  - `values.matchResults.matchingProfile.matchingScores.overall.classification.name` (string)
    Name of the Matching Classification.
    Example: "My Matching Configuration"

  - `values.matchResults.matchingProfile.matchingScores.overall.value` (number)
    Matching score value.
    Example: "0.9"

  - `values.matchResults.matchingProfile.matchingScores.overall.explanation` (string)
    Explanation for matching score value.
    Example: "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"

  - `values.matchResults.matchingProfile.matchingScores.businessPartner` (object)
    Shows numerical value of similarity between Business Partners or address stored in the Data Mirror and the Business Partner from the request.

  - `values.matchResults.matchingProfile.matchingScores.address` (object)
    Shows numerical value of similarity between Business Partners or address stored in the Data Mirror and the Business Partner from the request.