# Data Validation API This API provides services used for business partner qualification Version: 3 ## Servers Production ``` https://api.cdq.com/data-validation/rest ``` ## Security ### apiKey Type: apiKey In: header Name: X-API-KEY ## Download OpenAPI description [Data Validation API](https://developer.cdq.com/_spec/apis/data-validation-api/@data-validation-api-v3/api-v3.yaml) ## Business Partners ### Qualify Business Partner - [POST /v3/businesspartners/qualify](https://developer.cdq.com/apis/data-validation-api/api-v3/qualification/paths/~1v3~1businesspartners~1qualify/post.md): BETAEndpoint used for Business Partner qualification. It is in version and may change without notice. ### Qualify Business Partner - [POST /v3/businesspartners/qualify](https://developer.cdq.com/apis/data-validation-api/api-v3/business-partners/paths/~1v3~1businesspartners~1qualify/post.md): BETAEndpoint used for Business Partner qualification. It is in version and may change without notice. ### Validate Business Partner - [POST /v2/businesspartners/validate](https://developer.cdq.com/apis/data-validation-api/api-v3/business-partners/paths/~1v2~1businesspartners~1validate/post.md): Validate business partners (i.e. identifiers, legal forms) and addresses (i.e. post codes) and receive a list of data defects in case of found data quality issues. #### Examples Check out our examples in the to better understand this endpoint. | Example | Description | | --- | --- | | Identifier exists and is valid | No related to the identifier and equals . Note that there might be data defects if you provide more details than the identifier (i.e. address data). | | Identifier does not exist in external data source | Entry in related to the identifier and < 4 | | Unknown status for an identifier existence (only response example)| < and the respective equals to . You may try again as this is typical a temporary issue.| ## Qualification Provides funcionalities for qualification of Business Partners. Includes endpoints that allow users to submit Business Partner data for qualification, retrieve qualification results, and handle various qualification scenarios. ### Qualify Business Partner - [POST /v3/businesspartners/qualify](https://developer.cdq.com/apis/data-validation-api/api-v3/qualification/paths/~1v3~1businesspartners~1qualify/post.md): BETAEndpoint used for Business Partner qualification. It is in version and may change without notice. ### Qualify Business Partner - [POST /v3/businesspartners/qualify](https://developer.cdq.com/apis/data-validation-api/api-v3/business-partners/paths/~1v3~1businesspartners~1qualify/post.md): BETAEndpoint used for Business Partner qualification. It is in version and may change without notice. ## Configuration Provides funcionalities for managing configurations. Includes endpoints that allow users to create, update, and delete configurations for the current user. ### List Users Configuration - [GET /configurations/businesspartnervalidation](https://developer.cdq.com/apis/data-validation-api/api-v3/configuration/paths/~1configurations~1businesspartnervalidation/get.md): Fetches the current users' configuration. If no configuration exists, a default configuration is returned. ### Create Configuration - [POST /configurations/businesspartnervalidation](https://developer.cdq.com/apis/data-validation-api/api-v3/configuration/paths/~1configurations~1businesspartnervalidation/post.md): Creates a new configuration for the current user. The configuration is stored in the users workspace and can be used for validation of business partners and identifiers. ### Fetch Configuration - [GET /configurations/businesspartnervalidation/{configurationId}](https://developer.cdq.com/apis/data-validation-api/api-v3/configuration/paths/~1configurations~1businesspartnervalidation~1%7Bconfigurationid%7D/get.md): Fetches an existing configuration for the current user. ### Update Configuration - [PUT /configurations/businesspartnervalidation/{configurationId}](https://developer.cdq.com/apis/data-validation-api/api-v3/configuration/paths/~1configurations~1businesspartnervalidation~1%7Bconfigurationid%7D/put.md): Updates an existing configuration for the current user. ### Delete Configuration - [DELETE /configurations/businesspartnervalidation/{configurationId}](https://developer.cdq.com/apis/data-validation-api/api-v3/configuration/paths/~1configurations~1businesspartnervalidation~1%7Bconfigurationid%7D/delete.md): Deletes a configuration for the current user. ### Read Business Partner Validation Configuration Version - [GET /configurations/businesspartnervalidation/{configurationId}/versions/{version}](https://developer.cdq.com/apis/data-validation-api/api-v3/configuration/paths/~1configurations~1businesspartnervalidation~1%7Bconfigurationid%7D~1versions~1%7Bversion%7D/get.md): Read a specific version of a business partner validation configuration by id and version number. ## Processing Logs Provides funcionalities for managing processing logs. Includes endpoints that allow users to read processing log results. ### List Processing Log Results - [GET /v2/validationlogs/{storageId}/results](https://developer.cdq.com/apis/data-validation-api/api-v3/processing-logs/paths/~1v2~1validationlogs~1%7Bstorageid%7D~1results/get.md): Retrieves latest data curation results persisted in Processing Log. Data is populated only when Data Monitor is configured for provided storage. ## Batch Validation ### Poll Record Validation Job - [GET /v2/recordvalidationjobs/{id}](https://developer.cdq.com/apis/data-validation-api/api-v3/batch-validation/paths/~1v2~1recordvalidationjobs~1%7Bid%7D/get.md): Polls the status of a record validation job. The job is finished when the status is either or . If the job is finished, the result can be fetched using the endpoint. ### Start Record Validation Job - [POST /v2/recordvalidationjobs](https://developer.cdq.com/apis/data-validation-api/api-v3/batch-validation/paths/~1v2~1recordvalidationjobs/post.md): Starts a new validation job on a provided storage ID. ### List Record Validation Batch Results - [GET /v2/recordvalidationjobs/{id}/results](https://developer.cdq.com/apis/data-validation-api/api-v3/batch-validation/paths/~1v2~1recordvalidationjobs~1%7Bid%7D~1results/get.md): Retrieve the results of a record validation job. ### Start Business Partner Validation Job - [POST /v2/businesspartnervalidationjobs](https://developer.cdq.com/apis/data-validation-api/api-v3/batch-validation/paths/~1v2~1businesspartnervalidationjobs/post.md): Start a new validation job on a provided storage ID. ### List Business Partner Validation Batch Results - [GET /v2/businesspartnervalidationjobs/{id}/results](https://developer.cdq.com/apis/data-validation-api/api-v3/batch-validation/paths/~1v2~1businesspartnervalidationjobs~1%7Bid%7D~1results/get.md): Retrieve the results of a Business Partner validation job. ## Records ### Validate Record - [POST /v2/records/validate](https://developer.cdq.com/apis/data-validation-api/api-v3/records/paths/~1v2~1records~1validate/post.md): Validates a custom record. If the custom knowledge graph also contains a mapping, the mapping is applied ad-hoc and CDL validation rules are applied as well.