# Referencedata API This API provides services to search and read reference data Version: 3 ## Servers Production ``` https://api.cdq.com/referencedata/rest ``` ## Security ### apiKey Type: apiKey In: header Name: X-API-KEY ## Download OpenAPI description [Referencedata API](https://developer.cdq.com/_spec/apis/referencedata-api/@referencedata-api-v3/api-v3.yaml) ## Business Partners Everything about Business Partners ### Fetch Business Partner - [POST /v3/businesspartners/fetch](https://developer.cdq.com/apis/referencedata-api/api-v3/business-partners/paths/~1v3~1businesspartners~1fetch/post.md): Retrieves the Business Partner based on the Lookup and returning the result of the single record. ### Fetch Business Partner Relations - [POST /v3/businesspartners/fetchrelations](https://developer.cdq.com/apis/referencedata-api/api-v3/business-partners/fetchrelations.md): Retrieves the Business Partner Relations based on the Lookup and returning the result of the single record. ### Fetch Batch Business Partners - [POST /v3/businesspartners/fetch-batch](https://developer.cdq.com/apis/referencedata-api/api-v3/business-partners/paths/~1v3~1businesspartners~1fetch-batch/post.md): Retrieves the Business Partners based on the Lookup and returning the result of the multiple records. ### Simplified Lookup Business Partners - [GET /v3/businesspartners/lookup](https://developer.cdq.com/apis/referencedata-api/api-v3/business-partners/paths/~1v3~1businesspartners~1lookup/get.md): 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. ### Lookup Business Partners - [POST /v3/businesspartners/lookup](https://developer.cdq.com/apis/referencedata-api/api-v3/business-partners/paths/~1v3~1businesspartners~1lookup/post.md): Perform a Business Partner lookup operation across all available Data Sources. The output of this operation will be a comprehensive list of Business Partners, each accompanied by their respective Data Sources and meticulously calculated matching scores. It is important to note that all accessible data sources are comprehensively documented within the Data_source Category on CDQ Wiki. The Data Sources are categorized as follows: * OPEN: These Data Sources are open to everyone without any registration requirement. * FREE: These Data Sources are free to use, but registration is required. * COMMERCIAL: These Data Sources are only available to commercial users. The results of the Business Partner lookup operation are sorted in descending order based on their matching scores. Additionally, the results are conveniently paginated, allowing for efficient navigation through the extensive list. The page size can be effortlessly customized to accommodate specific preferences. ### Search Business Partners - [POST /v3/businesspartners/search](https://developer.cdq.com/apis/referencedata-api/api-v3/business-partners/paths/~1v3~1businesspartners~1search/post.md): Use for single queries to quickly find a Business Partner. User have to verify the results. To be used when Business Partner is not normalized e.g. Company Name and Address are in one line. ### Generate Golden Record - [POST /v3/businesspartners/goldenrecord](https://developer.cdq.com/apis/referencedata-api/api-v3/business-partners/paths/~1v3~1businesspartners~1goldenrecord/post.md): Create a Business Partner's golden record by computing the matching score using data completeness. The golden record generated has the highest matching score. ### Create Supplier Gateway Record - [POST /sgw/businesspartners](https://developer.cdq.com/apis/referencedata-api/api-v3/business-partners/paths/~1sgw~1businesspartners/post.md): Creates a new Supplier Gateway record by providing the necessary information and returns the created record. ### Fetch Supplier Gateway Record - [POST /sgw/businesspartners/fetch](https://developer.cdq.com/apis/referencedata-api/api-v3/business-partners/paths/~1sgw~1businesspartners~1fetch/post.md): Fetches a Supplier Gateway record by providing the necessary information and returns the fetched record. ### Fetch DNB Record (deprecated) - [POST /dnb/businesspartners/fetch](https://developer.cdq.com/apis/referencedata-api/api-v3/business-partners/paths/~1dnb~1businesspartners~1fetch/post.md): Fetch D&B record by CDQ-ID. It is possible to read: - legacy CMPELK data - Data Blocks defined here # Fetch CMPELK To fetch the CMPELK object no features have to be activated. # Fetch Data Blocks It is possible to read pre-defined Data Blocks ## Fetch pre-defined Data Blocks There are 2 features with pre-defined data blocks: - ACTIVATE_MASTER_DATA_BASIC uses following data blocks: * COMPANYINFO_L1_V1 - ACTIVATE_MASTER_DATA_EXTENDED uses following data blocks: * COMPANYINFO_L1_V1 * COMPANYINFO_L2_V1 * HIERARCHYCONNECTIONS_L1_V1 * PRINCIPALSCONTACTS_L2_V2 # Fetch LNKELI It is possible to fetch LNKELI data: ## Configurations ### List Fetch Configurations - [GET /configurations/businesspartnerfetch](https://developer.cdq.com/apis/referencedata-api/api-v3/configurations/paths/~1configurations~1businesspartnerfetch/get.md): List all fetch configurations of the current user. ### Create Fetch Configuration - [POST /configurations/businesspartnerfetch](https://developer.cdq.com/apis/referencedata-api/api-v3/configurations/paths/~1configurations~1businesspartnerfetch/post.md): Create a new fetch configuration for the current user. ### Read Fetch Configuration - [GET /configurations/businesspartnerfetch/{configurationId}](https://developer.cdq.com/apis/referencedata-api/api-v3/configurations/paths/~1configurations~1businesspartnerfetch~1%7Bconfigurationid%7D/get.md): Read a fetch configuration of the current user. ### Update Fetch Configuration - [PUT /configurations/businesspartnerfetch/{configurationId}](https://developer.cdq.com/apis/referencedata-api/api-v3/configurations/paths/~1configurations~1businesspartnerfetch~1%7Bconfigurationid%7D/put.md): Update a fetch configuration of the current user. ### Delete Fetch Configuration - [DELETE /configurations/businesspartnerfetch/{configurationId}](https://developer.cdq.com/apis/referencedata-api/api-v3/configurations/paths/~1configurations~1businesspartnerfetch~1%7Bconfigurationid%7D/delete.md): Delete a fetch configuration of the current user. ### List Lookup Configurations - [GET /configurations/businesspartnerlookup](https://developer.cdq.com/apis/referencedata-api/api-v3/configurations/paths/~1configurations~1businesspartnerlookup/get.md): List all lookup configurations of the current user. ### Read Lookup Configuration - [GET /configurations/businesspartnerlookup/{configurationId}](https://developer.cdq.com/apis/referencedata-api/api-v3/configurations/paths/~1configurations~1businesspartnerlookup~1%7Bconfigurationid%7D/get.md): Read a lookup configuration of the current user. ### Update Lookup Configuration - [PUT /configurations/businesspartnerlookup/{configurationId}](https://developer.cdq.com/apis/referencedata-api/api-v3/configurations/paths/~1configurations~1businesspartnerlookup~1%7Bconfigurationid%7D/put.md): Update a lookup configuration of the current user. ### Delete Lookup Configuration - [DELETE /configurations/businesspartnerlookup/{configurationId}](https://developer.cdq.com/apis/referencedata-api/api-v3/configurations/paths/~1configurations~1businesspartnerlookup~1%7Bconfigurationid%7D/delete.md): Delete a lookup configuration of the current user. ## Configuration ### Read Business Partner Fetch Configuration Version - [GET /configurations/businesspartnerfetch/{configurationId}/versions/{version}](https://developer.cdq.com/apis/referencedata-api/api-v3/configuration/paths/~1configurations~1businesspartnerfetch~1%7Bconfigurationid%7D~1versions~1%7Bversion%7D/get.md): Read a specific version of a business partner fetch configuration by id and version number. ### Read Business partner Lookup Configuration Version - [GET /configurations/businesspartnerlookup/{configurationId}/versions/{version}](https://developer.cdq.com/apis/referencedata-api/api-v3/configuration/paths/~1configurations~1businesspartnerlookup~1%7Bconfigurationid%7D~1versions~1%7Bversion%7D/get.md): Read a specific version of a business partner lookup configuration by id and version number. ## Processing Logs ### List Processing Log Results - [GET /v3/overlaplogs/{storageId}/results](https://developer.cdq.com/apis/referencedata-api/api-v3/processing-logs/paths/~1v3~1overlaplogs~1%7Bstorageid%7D~1results/get.md): Retrieves latest overlap results persisted in Processing Log. Data is populated only when Data Monitor is configured for provided storage. ## Batch Lookup ### Read DNB Lookup Job results - [GET /dnb/lookupjobs/{id}/results](https://developer.cdq.com/apis/referencedata-api/api-v3/batch-lookup/paths/~1dnb~1lookupjobs~1%7Bid%7D~1results/get.md): Reads the results of a DNB lookup job by job ID. ### Start DNB Lookup Job - [POST /dnb/lookupjobs](https://developer.cdq.com/apis/referencedata-api/api-v3/batch-lookup/paths/~1dnb~1lookupjobs/post.md): Initialisation of a DNB lookup job. The job will be executed asynchronously. The response contains the job ID which can be used to poll for the status of the job. ### Poll DNB Lookup Job - [GET /dnb/lookupjobs/{id}](https://developer.cdq.com/apis/referencedata-api/api-v3/batch-lookup/paths/~1dnb~1lookupjobs~1%7Bid%7D/get.md): After you have started a curation job, you will receive a job id in the response: Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED, you can download the results.