{"items":[{"type":"link","label":"Data Validation API","link":"/apis/data-validation-api/data-validation-api-v2/api-v2","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2","content":{"contentType":"overview","meta":{"name":"Data Validation API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api-v2.json","url":"/_bundle/apis/data-validation-api/@data-validation-api-v2/api-v2.json?download"},{"kind":"download","label":"api-v2.yaml","url":"/_bundle/apis/data-validation-api/@data-validation-api-v2/api-v2.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"java","title":"Java","lang":"Java"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"python","title":"Python","lang":"Python"},{"key":"node","title":"Node.js","lang":"Node.js"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"description":"Production","url":"https://api.cdq.com/data-validation/rest","x-cdq-soap-url":"https://api.corporate-data-league.ch/data-validation/soap/v2"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Data Validation API (2)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Build version:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2-5.99.9"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API provides services to validate businesspartners and identifiers"},"children":[]}]}]}]}],"sectionId":"/apis/data-validation-api/data-validation-api-v2/api-v2"}],"sectionId":"/apis/data-validation-api/data-validation-api-v2/api-v2"}]}]}},{"type":"group","label":"Batch Validation","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/batch-validation","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/batch-validation","items":[{"label":"List Record Validation Batch Results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/batch-validation/paths/~1v2~1recordvalidationjobs~1{id}~1results/get","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/batch-validation/paths/~1v2~1recordvalidationjobs~1{id}~1results/get","metadata":{"seo":{"title":"List Record Validation Batch Results","description":"Retrieve the results of a record validation job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Record Validation Batch Results","isWebhook":false,"pointer":"/paths/~1v2~1recordvalidationjobs~1{id}~1results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Record Validation Batch Results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the results of a record validation job."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"ID of the Record Validation Job.","required":true}],"pointer":"/paths/~1v2~1recordvalidationjobs~1{id}~1results/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"recordId","in":"query","schemaId":"schema_1","description":"Record IDs which should be filtered."},{"name":"startAfter","in":"query","schemaId":"schema_2","description":"Used to retrieve the next page of results."},{"name":"limit","in":"query","schemaId":"schema_3","description":"Number of results that should be fetched. Maximum 100 results can be returned in one page."}],"pointer":"/paths/~1v2~1recordvalidationjobs~1{id}~1results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/recordvalidationjobs/{id}/results","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6be92567-4327-4463-813f-a8c990410d79","schemaId":"schema_0"}],"query":[{"name":"recordId","in":"query","required":false,"schemaId":"schema_1"},{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"components/schemas/StartAfter"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"components/schemas/Limit"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/recordvalidationjobs/{id}/results","href":"batch-validation/paths/~1v2~1recordvalidationjobs~1{id}~1results/get","summary":"List Record Validation Batch Results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecordValidationJobResultPage"}},"schemaId":"components/schemas/RecordValidationJobResultPage"}],"pointer":"/paths/~1v2~1recordvalidationjobs~1{id}~1results/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecordValidationJobResultPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecordValidationJobResultPage"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-validation/paths/~1v2~1recordvalidationjobs~1{id}~1results/get"}],"panels":[]}]},"httpPath":"/v2/recordvalidationjobs/{id}/results"},{"label":"Start Business Partner Validation Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/batch-validation/paths/~1v2~1businesspartnervalidationjobs/post","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/batch-validation/paths/~1v2~1businesspartnervalidationjobs/post","metadata":{"seo":{"title":"Start Business Partner Validation Job","description":"Start a new validation job on a provided storage ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Start Business Partner Validation Job","isWebhook":false,"pointer":"/paths/~1v2~1businesspartnervalidationjobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start Business Partner Validation Job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Start a new validation job on a provided storage ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerValidationJobRequest","exampleIds":["paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/example","paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/tutorial"]}},"schemaId":"components/schemas/BusinessPartnerValidationJobRequest","exampleIds":["paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/example","paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/tutorial"],"pointer":"/paths/~1v2~1businesspartnervalidationjobs/post/requestBody","description":"cmd"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/businesspartnervalidationjobs","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessPartnerValidationJobRequest","exampleIds":["paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/example","paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/tutorial"]}},"responseCodes":["200","201","400","401","403","404"],"pointer":"/v2/businesspartnervalidationjobs","href":"batch-validation/paths/~1v2~1businesspartnervalidationjobs/post","summary":"Start Business Partner Validation Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"schemaId":"components/schemas/BusinessPartnerValidationJobRequest","exampleIds":["paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/example","paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/tutorial"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerValidationJobRequest","exampleIds":["paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/example","paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/tutorial"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerValidationJob"}},"schemaId":"components/schemas/BusinessPartnerValidationJob"},{"code":"201","description":"Created"},{"code":"400","description":"The sent request is malformed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v2~1businesspartnervalidationjobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerValidationJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerValidationJob"}}},{"code":"201"},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-validation/paths/~1v2~1businesspartnervalidationjobs/post"}],"panels":[]}]},"httpPath":"/v2/businesspartnervalidationjobs"},{"label":"List Business Partner Validation Batch Results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/batch-validation/paths/~1v2~1businesspartnervalidationjobs~1{id}~1results/get","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/batch-validation/paths/~1v2~1businesspartnervalidationjobs~1{id}~1results/get","metadata":{"seo":{"title":"List Business Partner Validation Batch Results","description":"Retrieve the results of a Business Partner validation job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Business Partner Validation Batch Results","isWebhook":false,"pointer":"/paths/~1v2~1businesspartnervalidationjobs~1{id}~1results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Business Partner Validation Batch Results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the results of a Business Partner validation job."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_4","description":"ID of the Lookup Job.","required":true}],"pointer":"/paths/~1v2~1businesspartnervalidationjobs~1{id}~1results/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"businessPartnerId","in":"query","schemaId":"schema_5","description":"Business Partner IDs which should be filtered."},{"name":"startAfter","in":"query","schemaId":"schema_2","description":"Only records with an ID greater than this ID will be fetched."},{"name":"limit","in":"query","schemaId":"schema_3","description":"Number of results that should be fetched. Maximum 100 results can be returned in one page."}],"pointer":"/paths/~1v2~1businesspartnervalidationjobs~1{id}~1results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/businesspartnervalidationjobs/{id}/results","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"cbed7ac6-a97d-4c23-9060-2a88fa660957","schemaId":"components/schemas/LookupJobId"}],"query":[{"name":"businessPartnerId","in":"query","required":false,"schemaId":"schema_5"},{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"components/schemas/StartAfter"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"components/schemas/Limit"},{"name":"includeValidationResultFields","in":"query","required":false,"schemaId":"schema_6"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/businesspartnervalidationjobs/{id}/results","href":"batch-validation/paths/~1v2~1businesspartnervalidationjobs~1{id}~1results/get","summary":"List Business Partner Validation Batch Results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerValidationJobResultPage"}},"schemaId":"components/schemas/BusinessPartnerValidationJobResultPage"}],"pointer":"/paths/~1v2~1businesspartnervalidationjobs~1{id}~1results/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerValidationJobResultPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerValidationJobResultPage"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-validation/paths/~1v2~1businesspartnervalidationjobs~1{id}~1results/get"}],"panels":[]}]},"httpPath":"/v2/businesspartnervalidationjobs/{id}/results"},{"label":"Poll Record Validation Job","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/batch-validation/paths/~1v2~1recordvalidationjobs~1{id}/get","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/batch-validation/paths/~1v2~1recordvalidationjobs~1{id}/get","metadata":{"seo":{"title":"Poll Record Validation Job","description":"Polls the status of a record validation job. The job is finished when the status is either FINISHED or FAILED. If the job is finished, the result can be fetched using the /v2/recordvalidationjobs/{id}/results endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Poll Record Validation Job","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v2~1recordvalidationjobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll Record Validation Job","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Polls the status of a record validation job. The job is finished when the status is either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINISHED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the job is finished, the result can be fetched using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/recordvalidationjobs/{id}/results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_7","description":"ID of the validation report.","required":true}],"pointer":"/paths/~1v2~1recordvalidationjobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/recordvalidationjobs/{id}","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"ef450653-a3bc-4476-83d3-d67397d475a0","schemaId":"components/schemas/DataValidationJobId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v2/recordvalidationjobs/{id}","href":"batch-validation/paths/~1v2~1recordvalidationjobs~1{id}/get","summary":"Poll Record Validation Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecordValidationJob"}},"schemaId":"components/schemas/RecordValidationJob"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v2~1recordvalidationjobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecordValidationJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecordValidationJob"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-validation/paths/~1v2~1recordvalidationjobs~1{id}/get"}],"panels":[]}]},"httpPath":"/v2/recordvalidationjobs/{id}"},{"label":"Start Record Validation Job","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/batch-validation/paths/~1v2~1recordvalidationjobs/post","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/batch-validation/paths/~1v2~1recordvalidationjobs/post","metadata":{"seo":{"title":"Start Record Validation Job","description":"Starts a new validation job on a provided storage ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Start Record Validation Job","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v2~1recordvalidationjobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start Record Validation Job","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Starts a new validation job on a provided storage ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecordValidationJobRequest"}},"schemaId":"components/schemas/RecordValidationJobRequest","pointer":"/paths/~1v2~1recordvalidationjobs/post/requestBody","description":"cmd"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/recordvalidationjobs","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RecordValidationJobRequest"}},"responseCodes":["200","201","400","401","403","404"],"pointer":"/v2/recordvalidationjobs","href":"batch-validation/paths/~1v2~1recordvalidationjobs/post","summary":"Start Record Validation Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"schemaId":"components/schemas/RecordValidationJobRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecordValidationJobRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecordValidationJob"}},"schemaId":"components/schemas/RecordValidationJob"},{"code":"201","description":"Created"},{"code":"400","description":"The sent request is malformed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v2~1recordvalidationjobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecordValidationJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecordValidationJob"}}},{"code":"201"},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-validation/paths/~1v2~1recordvalidationjobs/post"}],"panels":[]}]},"httpPath":"/v2/recordvalidationjobs"}],"content":{"contentType":"group","meta":{"name":"Batch Validation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch Validation","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for validation of multiple records or entities in a single request. Includes endpoints that \nallow users to start validation jobs, poll the status of these jobs, and retrieve validation results."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/recordvalidationjobs/{id}/results","summary":"List Record Validation Batch Results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-validation/paths/~1v2~1recordvalidationjobs~1{id}~1results/get","deprecated":false},{"title":"/v2/businesspartnervalidationjobs","summary":"Start Business Partner Validation Job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-validation/paths/~1v2~1businesspartnervalidationjobs/post","deprecated":false},{"title":"/v2/businesspartnervalidationjobs/{id}/results","summary":"List Business Partner Validation Batch Results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-validation/paths/~1v2~1businesspartnervalidationjobs~1{id}~1results/get","deprecated":false},{"title":"/v2/recordvalidationjobs/{id}","summary":"Poll Record Validation Job","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/batch-validation/paths/~1v2~1recordvalidationjobs~1{id}/get","deprecated":true},{"title":"/v2/recordvalidationjobs","summary":"Start Record Validation Job","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/batch-validation/paths/~1v2~1recordvalidationjobs/post","deprecated":true}]}]}]}]}},{"type":"group","label":"Business Partners","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/business-partners","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/business-partners","items":[{"label":"Validate Business Partner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/business-partners/paths/~1v2~1businesspartners~1validate/post","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/business-partners/paths/~1v2~1businesspartners~1validate/post","metadata":{"seo":{"title":"Validate Business Partner","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Validate Business Partner","isWebhook":false,"pointer":"/paths/~1v2~1businesspartners~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate Business Partner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"business-partners/paths/~1v2~1businesspartners~1validate/post/request/examples","deepLinkHash":"/business-partners/paths/~1v2~1businesspartners~1validate/post#business-partners/paths/~1v2~1businesspartners~1validate/post/request/examples"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check out our examples in the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it console"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to better understand this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier exists and is valid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataDefects"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" related to the identifier and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierReliability.level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note that there might be data defects if you provide more details than the identifier (i.e. address data)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier does not exist in external data source"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataDefects"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" related to the identifier and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierReliability.level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" < 4"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown status for an identifier existence (only response example)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierReliability.level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" < "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  and the respective "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external service error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You may try again as this is typical a temporary issue."},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SingleBusinessPartnerValidationRequest","exampleIds":["paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongUid","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongCNPJ","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateSelectedRules","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateNewQualificationMode","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/oldQualification","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierExistsAndIsValid","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierDoesNotExistInExternalDataSource","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/quotaLimitExceeded"]}},"schemaId":"components/schemas/SingleBusinessPartnerValidationRequest","exampleIds":["paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongUid","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongCNPJ","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateSelectedRules","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateNewQualificationMode","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/oldQualification","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierExistsAndIsValid","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierDoesNotExistInExternalDataSource","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/quotaLimitExceeded"],"pointer":"/paths/~1v2~1businesspartners~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/businesspartners/validate","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SingleBusinessPartnerValidationRequest","exampleIds":["paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongUid","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongCNPJ","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateSelectedRules","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateNewQualificationMode","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/oldQualification","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierExistsAndIsValid","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierDoesNotExistInExternalDataSource","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/quotaLimitExceeded"]}},"responseCodes":["200"],"pointer":"/v2/businesspartners/validate","href":"business-partners/paths/~1v2~1businesspartners~1validate/post","summary":"Validate Business Partner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"schemaId":"components/schemas/SingleBusinessPartnerValidationRequest","exampleIds":["paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongUid","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongCNPJ","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateSelectedRules","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateNewQualificationMode","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/oldQualification","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierExistsAndIsValid","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierDoesNotExistInExternalDataSource","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/quotaLimitExceeded"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SingleBusinessPartnerValidationRequest","exampleIds":["paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongUid","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongCNPJ","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateSelectedRules","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateNewQualificationMode","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/oldQualification","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierExistsAndIsValid","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierDoesNotExistInExternalDataSource","paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/quotaLimitExceeded"]}},"examples":[{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerValidationResult","exampleIds":["paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/identifierExistsAndIsValid","paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/identifierDoesNotExistInExternalDataSource","paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/unknownValidityForAnIdentifier","paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/quotaLimitExceeded"]},"application/xml":{"schemaId":"components/schemas/BusinessPartnerValidationResult"}},"schemaId":"components/schemas/BusinessPartnerValidationResult","exampleIds":["paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/identifierExistsAndIsValid","paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/identifierDoesNotExistInExternalDataSource","paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/unknownValidityForAnIdentifier","paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/quotaLimitExceeded"]}],"pointer":"/paths/~1v2~1businesspartners~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerValidationResult","exampleIds":["paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/identifierExistsAndIsValid","paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/identifierDoesNotExistInExternalDataSource","paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/unknownValidityForAnIdentifier","paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/quotaLimitExceeded"],"mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerValidationResult","exampleIds":["paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/identifierExistsAndIsValid","paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/identifierDoesNotExistInExternalDataSource","paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/unknownValidityForAnIdentifier","paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/quotaLimitExceeded"]},"application/xml":{"schemaId":"components/schemas/BusinessPartnerValidationResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1v2~1businesspartners~1validate/post"}],"panels":[]}]},"httpPath":"/v2/businesspartners/validate"}],"content":{"contentType":"group","meta":{"name":"Business Partners"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Business Partners","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for managing Business Partners. Includes endpoints that allow users to validate Business Partners\nagainst data quality rules."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/businesspartners/validate","summary":"Validate Business Partner","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partners/paths/~1v2~1businesspartners~1validate/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Processing Logs","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/processing-logs","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/processing-logs","items":[{"label":"List Processing Log Results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/processing-logs/paths/~1v2~1validationlogs~1{storageid}~1results/get","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/processing-logs/paths/~1v2~1validationlogs~1{storageid}~1results/get","metadata":{"seo":{"title":"List Processing Log Results","description":"Retrieves latest data curation results persisted in Processing Log."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Processing Log Results","isWebhook":false,"pointer":"/paths/~1v2~1validationlogs~1{storageId}~1results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Processing Log Results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves latest data curation results persisted in Processing Log."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data is populated only when "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/data-exchange-api-v2/api-v2/data-monitors/paths/~1v2~1storages~1%7Bstorageid%7D~1datamonitors/post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Monitor"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured for provided storage."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"storageId","in":"path","schemaId":"schema_8","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v2~1validationlogs~1{storageId}~1results/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"processingLogId","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing log id with acceptable values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VALIDATION_LOG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VALIDATION_SHARING_LOG"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VALIDATION_LOG is default value."},"children":[]}]}]}]}],"required":true},{"name":"businessPartnerId","in":"query","schemaId":"schema_10","description":"Business Partner IDs which should be filtered."},{"name":"dataSourceId","in":"query","schemaId":"schema_11","description":"Data Source ID."},{"name":"externalId","in":"query","schemaId":"schema_12","description":"Business Partner external IDs."},{"name":"processingStatusTechnicalKey","in":"query","schemaId":"schema_13","description":"Processing status technical key."},{"name":"startAfter","in":"query","schemaId":"schema_2","description":"Only records with an ID greater than this ID will be fetched."},{"name":"limit","in":"query","schemaId":"schema_14","description":"Number of results that should be fetched. Maximum 100 results can be returned in one page."},{"name":"from","in":"query","schemaId":"schema_15","description":"ISO 8601 representation of the timestamp when the result data was created."},{"name":"to","in":"query","schemaId":"schema_15","description":"ISO 8601 representation of the timestamp when the result data was created."}],"pointer":"/paths/~1v2~1validationlogs~1{storageId}~1results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/validationlogs/{storageId}/results","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[{"name":"processingLogId","in":"query","required":true,"example":"VALIDATION_LOG","schemaId":"components/schemas/ValidationProcessingLogIdParam"},{"name":"businessPartnerId","in":"query","required":false,"schemaId":"schema_10"},{"name":"dataSourceId","in":"query","required":false,"example":"648824a691d8d2503d65103e","schemaId":"components/schemas/BusinessPartnerStorageDataSourceId"},{"name":"externalId","in":"query","required":false,"schemaId":"schema_12"},{"name":"processingStatusTechnicalKey","in":"query","required":false,"example":"IN_PROGRESS","schemaId":"components/schemas/ProcessingStatusTechnicalKeyEnum"},{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"components/schemas/StartAfter"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"components/schemas/Limit"},{"name":"from","in":"query","required":false,"example":"2026-11-10T13:37:16Z","schemaId":"schema_15"},{"name":"to","in":"query","required":false,"example":"2026-11-10T13:37:16Z","schemaId":"schema_15"},{"name":"featuresOff","in":"query","schemaId":"schema_16"},{"name":"includeValidationResultFields","in":"query","required":false,"schemaId":"schema_6"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/validationlogs/{storageId}/results","href":"processing-logs/paths/~1v2~1validationlogs~1{storageid}~1results/get","summary":"List Processing Log Results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationProcessingLogResultPage"}},"schemaId":"components/schemas/ValidationProcessingLogResultPage"}],"pointer":"/paths/~1v2~1validationlogs~1{storageId}~1results/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ValidationProcessingLogResultPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationProcessingLogResultPage"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processing-logs/paths/~1v2~1validationlogs~1{storageid}~1results/get"}],"panels":[]}]},"httpPath":"/v2/validationlogs/{storageId}/results"}],"content":{"contentType":"group","meta":{"name":"Processing Logs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processing Logs","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for managing processing logs. Includes endpoints that allow users to read processing log\nresults."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/validationlogs/{storageId}/results","summary":"List Processing Log Results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/processing-logs/paths/~1v2~1validationlogs~1{storageid}~1results/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Records","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/records","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/records","items":[{"label":"Validate Record","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/records/paths/~1v2~1records~1validate/post","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/records/paths/~1v2~1records~1validate/post","metadata":{"seo":{"title":"Validate Record","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Validate Record","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v2~1records~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate Record","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SingleRecordValidationRequest"}},"schemaId":"components/schemas/SingleRecordValidationRequest","pointer":"/paths/~1v2~1records~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/records/validate","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SingleRecordValidationRequest"}},"responseCodes":["200"],"pointer":"/v2/records/validate","href":"records/paths/~1v2~1records~1validate/post","summary":"Validate Record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"schemaId":"components/schemas/SingleRecordValidationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SingleRecordValidationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecordValidationResult"},"application/xml":{"schemaId":"components/schemas/RecordValidationResult"}},"schemaId":"components/schemas/RecordValidationResult"}],"pointer":"/paths/~1v2~1records~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecordValidationResult","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecordValidationResult"},"application/xml":{"schemaId":"components/schemas/RecordValidationResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/records/paths/~1v2~1records~1validate/post"}],"panels":[]}]},"httpPath":"/v2/records/validate"}],"content":{"contentType":"group","meta":{"name":"Records"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Records","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for managing records. Includes endpoints that allow users to validate records."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/records/validate","summary":"Validate Record","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/records/paths/~1v2~1records~1validate/post","deprecated":true}]}]}]}]}},{"type":"group","label":"Configuration","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration","items":[{"label":"List Users Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1businesspartnervalidation/get","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1businesspartnervalidation/get","metadata":{"seo":{"title":"List Users Configuration","description":"Fetches the current users' configuration. If no configuration exists, a default configuration is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Users Configuration","isWebhook":false,"pointer":"/paths/~1configurations~1businesspartnervalidation/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Users Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches the current users' configuration. If no configuration exists, a default configuration is returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startAfter","in":"query","schemaId":"schema_2","description":"Start after the given index. Use this to paginate through the results. The first page is returned if this parameter is not provided."},{"name":"limit","in":"query","schemaId":"schema_19","description":"Maximum number of results to return. The default is 100."},{"name":"defaultConfiguration","in":"query","schemaId":"schema_20","description":"Limit search to configurations with the provided default flag value. If left empty, all configurations will be returned."},{"name":"clientId","in":"query","schemaId":"schema_21","description":"API Key ID or Client ID. When present returns only configurations assigned to the given API key."}],"pointer":"/paths/~1configurations~1businesspartnervalidation/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/configurations/businesspartnervalidation","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"workspaceId","in":"query","required":false,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"components/schemas/WorkspaceId"},{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"components/schemas/StartAfter"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"components/schemas/Limit"},{"name":"defaultConfiguration","in":"query","required":false,"example":true,"schemaId":"components/schemas/DefaultWorkspaceConfiguration"},{"name":"clientId","in":"query","required":false,"example":"12345678-1234-5678-1234-567812345678","schemaId":"schema_21"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/configurations/businesspartnervalidation","href":"configuration/paths/~1configurations~1businesspartnervalidation/get","summary":"List Users Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResponsePage","exampleIds":["paths/~1configurations~1businesspartnervalidation/get/responses/200/content/application~1json/examples/fetchConfigurations"]}},"schemaId":"components/schemas/WorkspaceConfigurationResponsePage","exampleIds":["paths/~1configurations~1businesspartnervalidation/get/responses/200/content/application~1json/examples/fetchConfigurations"]}],"pointer":"/paths/~1configurations~1businesspartnervalidation/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkspaceConfigurationResponsePage","exampleIds":["paths/~1configurations~1businesspartnervalidation/get/responses/200/content/application~1json/examples/fetchConfigurations"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResponsePage","exampleIds":["paths/~1configurations~1businesspartnervalidation/get/responses/200/content/application~1json/examples/fetchConfigurations"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/paths/~1configurations~1businesspartnervalidation/get"}],"panels":[]}]},"httpPath":"/configurations/businesspartnervalidation"},{"label":"Create Configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1businesspartnervalidation/post","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1businesspartnervalidation/post","metadata":{"seo":{"title":"Create Configuration","description":"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.If given configuration is empty or lacks validationProfile - STANDARD profile will be used as default."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create Configuration","isWebhook":false,"pointer":"/paths/~1configurations~1businesspartnervalidation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new configuration for the current user."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The configuration is stored in the users workspace and can be used for validation of business partners and identifiers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If given configuration is empty or lacks "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validationProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" profile will be used as default."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationCreate","exampleIds":["paths/~1configurations~1businesspartnervalidation/post/requestBody/content/application~1json/examples/createComplexConfiguration"]}},"schemaId":"components/schemas/WorkspaceConfigurationCreate","exampleIds":["paths/~1configurations~1businesspartnervalidation/post/requestBody/content/application~1json/examples/createComplexConfiguration"],"pointer":"/paths/~1configurations~1businesspartnervalidation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/configurations/businesspartnervalidation","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationCreate","exampleIds":["paths/~1configurations~1businesspartnervalidation/post/requestBody/content/application~1json/examples/createComplexConfiguration"]}},"responseCodes":["200","400"],"pointer":"/configurations/businesspartnervalidation","href":"configuration/paths/~1configurations~1businesspartnervalidation/post","summary":"Create Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"schemaId":"components/schemas/WorkspaceConfigurationCreate","exampleIds":["paths/~1configurations~1businesspartnervalidation/post/requestBody/content/application~1json/examples/createComplexConfiguration"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationCreate","exampleIds":["paths/~1configurations~1businesspartnervalidation/post/requestBody/content/application~1json/examples/createComplexConfiguration"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Configuration created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation/post/responses/200/content/application~1json/examples/createComplexConfiguration"]}},"schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation/post/responses/200/content/application~1json/examples/createComplexConfiguration"]},{"code":"400","description":"Bad Request."}],"pointer":"/paths/~1configurations~1businesspartnervalidation/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation/post/responses/200/content/application~1json/examples/createComplexConfiguration"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation/post/responses/200/content/application~1json/examples/createComplexConfiguration"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/paths/~1configurations~1businesspartnervalidation/post"}],"panels":[]}]},"httpPath":"/configurations/businesspartnervalidation"},{"label":"Fetch Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/get","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/get","metadata":{"seo":{"title":"Fetch Configuration","description":"Fetches an existing configuration for the current user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Fetch Configuration","isWebhook":false,"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches an existing configuration for the current user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"configurationId","in":"path","schemaId":"schema_22","description":"ID of the configuration.","required":true}],"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[],"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/configurations/businesspartnervalidation/{configurationId}","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[{"name":"configurationId","in":"path","required":true,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"schema_22"}],"query":[{"name":"workspaceId","in":"query","required":false,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"components/schemas/WorkspaceId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/configurations/businesspartnervalidation/{configurationId}","href":"configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/get","summary":"Fetch Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/get/responses/200/content/application~1json/examples/getConfiguration"]}},"schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/get/responses/200/content/application~1json/examples/getConfiguration"]}],"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/get/responses/200/content/application~1json/examples/getConfiguration"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/get/responses/200/content/application~1json/examples/getConfiguration"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/get"}],"panels":[]}]},"httpPath":"/configurations/businesspartnervalidation/{configurationId}"},{"label":"Update Configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/put","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/put","metadata":{"seo":{"title":"Update Configuration","description":"Updates an existing configuration for the current user. If given configuration is empty or lacks validationProfile - STANDARD profile will be used as default."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Configuration","isWebhook":false,"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing configuration for the current user. If given configuration is empty or lacks "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validationProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" profile will be used as default."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"configurationId","in":"path","schemaId":"schema_22","description":"ID of the configuration.","required":true}],"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationUpdate","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/clearConfigurationToDefaults","paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/updateFeaturesOnList"]}},"schemaId":"components/schemas/WorkspaceConfigurationUpdate","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/clearConfigurationToDefaults","paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/updateFeaturesOnList"],"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/configurations/businesspartnervalidation/{configurationId}","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[{"name":"configurationId","in":"path","required":true,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationUpdate","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/clearConfigurationToDefaults","paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/updateFeaturesOnList"]}},"responseCodes":["200","400"],"pointer":"/configurations/businesspartnervalidation/{configurationId}","href":"configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/put","summary":"Update Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"schemaId":"components/schemas/WorkspaceConfigurationUpdate","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/clearConfigurationToDefaults","paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/updateFeaturesOnList"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationUpdate","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/clearConfigurationToDefaults","paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/updateFeaturesOnList"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Configuration updated successful.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/responses/200/content/application~1json/examples/clearConfigurationToDefaults","paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/responses/200/content/application~1json/examples/updatedFeaturesOnList"]}},"schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/responses/200/content/application~1json/examples/clearConfigurationToDefaults","paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/responses/200/content/application~1json/examples/updatedFeaturesOnList"]},{"code":"400","description":"Bad Request."}],"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/responses/200/content/application~1json/examples/clearConfigurationToDefaults","paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/responses/200/content/application~1json/examples/updatedFeaturesOnList"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/responses/200/content/application~1json/examples/clearConfigurationToDefaults","paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/responses/200/content/application~1json/examples/updatedFeaturesOnList"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/put"}],"panels":[]}]},"httpPath":"/configurations/businesspartnervalidation/{configurationId}"},{"label":"Delete Configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/delete","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/delete","metadata":{"seo":{"title":"Delete Configuration","description":"Deletes a configuration for the current user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete Configuration","isWebhook":false,"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a configuration for the current user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"configurationId","in":"path","schemaId":"schema_22","description":"ID of the configuration.","required":true}],"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[],"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/configurations/businesspartnervalidation/{configurationId}","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[{"name":"configurationId","in":"path","required":true,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"schema_22"}],"query":[{"name":"workspaceId","in":"query","required":false,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"components/schemas/WorkspaceId"},{"name":"transactionId","in":"query","required":false,"example":"8e37da1e-ee9d-4ee0-b03d-24a1f89988f2","schemaId":"components/schemas/TransactionId"},{"name":"featuresOn","in":"query","required":false,"schemaId":"schema_24"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/configurations/businesspartnervalidation/{configurationId}","href":"configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/delete","summary":"Delete Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/delete/responses/200/content/application~1json/examples/successfulDeletion"]}},"schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/delete/responses/200/content/application~1json/examples/successfulDeletion"]},{"code":"400","description":"Bad Request."}],"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/delete/responses/200/content/application~1json/examples/successfulDeletion"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}/delete/responses/200/content/application~1json/examples/successfulDeletion"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/delete"}],"panels":[]}]},"httpPath":"/configurations/businesspartnervalidation/{configurationId}"},{"label":"Read Business Partner Validation Configuration Version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}~1versions~1{version}/get","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}~1versions~1{version}/get","metadata":{"seo":{"title":"Read Business Partner Validation Configuration Version","description":"Read a specific version of a business partner validation configuration by id and version number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Read Business Partner Validation Configuration Version","isWebhook":false,"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}~1versions~1{version}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read Business Partner Validation Configuration Version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read a specific version of a business partner validation configuration by id and version number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"configurationId","in":"path","schemaId":"schema_22","description":"ID of the configuration.","required":true},{"name":"version","in":"path","schemaId":"schema_25","description":"Version number of the configuration.","required":true}],"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}~1versions~1{version}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[],"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}~1versions~1{version}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/configurations/businesspartnervalidation/{configurationId}/versions/{version}","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[{"name":"configurationId","in":"path","required":true,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"schema_22"},{"name":"version","in":"path","required":true,"example":1,"schemaId":"schema_25"}],"query":[{"name":"workspaceId","in":"query","required":false,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"components/schemas/WorkspaceId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/configurations/businesspartnervalidation/{configurationId}/versions/{version}","href":"configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}~1versions~1{version}/get","summary":"Read Business Partner Validation Configuration Version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationVersionResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/getConfigurationForVersion"]}},"schemaId":"components/schemas/WorkspaceConfigurationVersionResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/getConfigurationForVersion"]}],"pointer":"/paths/~1configurations~1businesspartnervalidation~1{configurationId}~1versions~1{version}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkspaceConfigurationVersionResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/getConfigurationForVersion"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationVersionResult","exampleIds":["paths/~1configurations~1businesspartnervalidation~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/getConfigurationForVersion"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}~1versions~1{version}/get"}],"panels":[]}]},"httpPath":"/configurations/businesspartnervalidation/{configurationId}/versions/{version}"},{"label":"List Tax Guard Identifier Qualification Configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1qualification/get","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1qualification/get","metadata":{"seo":{"title":"List Tax Guard Identifier Qualification Configurations","description":"List all Tax Guard Identifier Qualification configurations of the current user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Tax Guard Identifier Qualification Configurations","isWebhook":false,"pointer":"/paths/~1configurations~1qualification/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Tax Guard Identifier Qualification Configurations","badges":[{"name":"BETA","color":"blue","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all Tax Guard Identifier Qualification configurations of the current user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_19","description":"Maximum number of configurations to return. Used for pagination."},{"name":"startAfter","in":"query","schemaId":"schema_2","description":"ID of the last configuration returned in the previous request. Used for pagination."},{"name":"defaultConfiguration","in":"query","schemaId":"schema_20","description":"Limit search to configurations with the provided default flag value. If left empty, all configurations will be returned."},{"name":"clientId","in":"query","schemaId":"schema_21","description":"API Key ID or Client ID. When present returns only configurations assigned to the given API key."}],"pointer":"/paths/~1configurations~1qualification/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/configurations/qualification","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"workspaceId","in":"query","required":false,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"components/schemas/WorkspaceId"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"components/schemas/Limit"},{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"components/schemas/StartAfter"},{"name":"defaultConfiguration","in":"query","required":false,"example":true,"schemaId":"components/schemas/DefaultWorkspaceConfiguration"},{"name":"clientId","in":"query","required":false,"example":"12345678-1234-5678-1234-567812345678","schemaId":"schema_21"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/configurations/qualification","href":"configuration/paths/~1configurations~1qualification/get","summary":"List Tax Guard Identifier Qualification Configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResponsePage","exampleIds":["paths/~1configurations~1qualification/get/responses/200/content/application~1json/examples/taxGuardConfigurations"]}},"schemaId":"components/schemas/WorkspaceConfigurationResponsePage","exampleIds":["paths/~1configurations~1qualification/get/responses/200/content/application~1json/examples/taxGuardConfigurations"]},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"401","description":"Unauthorized access.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"}],"pointer":"/paths/~1configurations~1qualification/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkspaceConfigurationResponsePage","exampleIds":["paths/~1configurations~1qualification/get/responses/200/content/application~1json/examples/taxGuardConfigurations"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResponsePage","exampleIds":["paths/~1configurations~1qualification/get/responses/200/content/application~1json/examples/taxGuardConfigurations"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"401","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"403","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"500","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/paths/~1configurations~1qualification/get"}],"panels":[]}]},"badges":[{"name":"BETA","color":"blue","position":"after"}],"httpPath":"/configurations/qualification"},{"label":"Read Tax Guard Identifier Qualification Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1qualification~1{configurationid}/get","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1qualification~1{configurationid}/get","metadata":{"seo":{"title":"Read Tax Guard Identifier Qualification Configuration","description":"Read an Tax Guard Identifier Qualification configuration of the current user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Read Tax Guard Identifier Qualification Configuration","isWebhook":false,"pointer":"/paths/~1configurations~1qualification~1{configurationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read Tax Guard Identifier Qualification Configuration","badges":[{"name":"BETA","color":"blue","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read an Tax Guard Identifier Qualification configuration of the current user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"configurationId","in":"path","schemaId":"schema_22","description":"ID of the configuration.","required":true}],"pointer":"/paths/~1configurations~1qualification~1{configurationId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[],"pointer":"/paths/~1configurations~1qualification~1{configurationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/configurations/qualification/{configurationId}","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[{"name":"configurationId","in":"path","required":true,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"schema_22"}],"query":[{"name":"workspaceId","in":"query","required":false,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"components/schemas/WorkspaceId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/configurations/qualification/{configurationId}","href":"configuration/paths/~1configurations~1qualification~1{configurationid}/get","summary":"Read Tax Guard Identifier Qualification Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QualificationConfigurationResult","exampleIds":["paths/~1configurations~1qualification~1{configurationId}/get/responses/200/content/application~1json/examples/fetchingConfiguration"]}},"schemaId":"components/schemas/QualificationConfigurationResult","exampleIds":["paths/~1configurations~1qualification~1{configurationId}/get/responses/200/content/application~1json/examples/fetchingConfiguration"]},{"code":"400","description":"Bad request, for example, missing organization ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"401","description":"Unauthorized access.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"}],"pointer":"/paths/~1configurations~1qualification~1{configurationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QualificationConfigurationResult","exampleIds":["paths/~1configurations~1qualification~1{configurationId}/get/responses/200/content/application~1json/examples/fetchingConfiguration"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QualificationConfigurationResult","exampleIds":["paths/~1configurations~1qualification~1{configurationId}/get/responses/200/content/application~1json/examples/fetchingConfiguration"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"401","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"403","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"500","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/paths/~1configurations~1qualification~1{configurationid}/get"}],"panels":[]}]},"badges":[{"name":"BETA","color":"blue","position":"after"}],"httpPath":"/configurations/qualification/{configurationId}"},{"label":"Read Tax Guard Identifier Qualification Configuration Version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1qualification~1{configurationid}~1versions~1{version}/get","routeSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2/configuration/paths/~1configurations~1qualification~1{configurationid}~1versions~1{version}/get","metadata":{"seo":{"title":"Read Tax Guard Identifier Qualification Configuration Version","description":"Read a specific version of an Tax Guard Identifier Qualification configuration by id and version number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Read Tax Guard Identifier Qualification Configuration Version","isWebhook":false,"pointer":"/paths/~1configurations~1qualification~1{configurationId}~1versions~1{version}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read Tax Guard Identifier Qualification Configuration Version","badges":[{"name":"BETA","color":"blue","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read a specific version of an Tax Guard Identifier Qualification configuration by id and version number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"configurationId","in":"path","schemaId":"schema_22","description":"ID of the configuration.","required":true},{"name":"version","in":"path","schemaId":"schema_25","description":"Version number of the configuration.","required":true}],"pointer":"/paths/~1configurations~1qualification~1{configurationId}~1versions~1{version}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[],"pointer":"/paths/~1configurations~1qualification~1{configurationId}~1versions~1{version}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/configurations/qualification/{configurationId}/versions/{version}","servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"parameters":{"path":[{"name":"configurationId","in":"path","required":true,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"schema_22"},{"name":"version","in":"path","required":true,"example":1,"schemaId":"schema_25"}],"query":[{"name":"workspaceId","in":"query","required":false,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"components/schemas/WorkspaceId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/configurations/qualification/{configurationId}/versions/{version}","href":"configuration/paths/~1configurations~1qualification~1{configurationid}~1versions~1{version}/get","summary":"Read Tax Guard Identifier Qualification Configuration Version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QualificationConfigurationVersionResult","exampleIds":["paths/~1configurations~1qualification~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/fetchingConfigurationForVersion"]}},"schemaId":"components/schemas/QualificationConfigurationVersionResult","exampleIds":["paths/~1configurations~1qualification~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/fetchingConfigurationForVersion"]}],"pointer":"/paths/~1configurations~1qualification~1{configurationId}~1versions~1{version}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QualificationConfigurationVersionResult","exampleIds":["paths/~1configurations~1qualification~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/fetchingConfigurationForVersion"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QualificationConfigurationVersionResult","exampleIds":["paths/~1configurations~1qualification~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/fetchingConfigurationForVersion"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/paths/~1configurations~1qualification~1{configurationid}~1versions~1{version}/get"}],"panels":[]}]},"badges":[{"name":"BETA","color":"blue","position":"after"}],"httpPath":"/configurations/qualification/{configurationId}/versions/{version}"}],"content":{"contentType":"group","meta":{"name":"Configuration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configuration","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for managing configurations. Includes endpoints that allow users to create, update, and delete \nconfigurations for the current user."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/configurations/businesspartnervalidation","summary":"List Users Configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration/paths/~1configurations~1businesspartnervalidation/get","deprecated":false},{"title":"/configurations/businesspartnervalidation","summary":"Create Configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/configuration/paths/~1configurations~1businesspartnervalidation/post","deprecated":false},{"title":"/configurations/businesspartnervalidation/{configurationId}","summary":"Fetch Configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/get","deprecated":false},{"title":"/configurations/businesspartnervalidation/{configurationId}","summary":"Update Configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/put","deprecated":false},{"title":"/configurations/businesspartnervalidation/{configurationId}","summary":"Delete Configuration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}/delete","deprecated":false},{"title":"/configurations/businesspartnervalidation/{configurationId}/versions/{version}","summary":"Read Business Partner Validation Configuration Version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration/paths/~1configurations~1businesspartnervalidation~1{configurationid}~1versions~1{version}/get","deprecated":false},{"title":"/configurations/qualification","summary":"List Tax Guard Identifier Qualification Configurations","prefix":{"name":"get","color":"get"},"badges":[{"name":"BETA","color":"blue","position":"after"}],"link":"/configuration/paths/~1configurations~1qualification/get","deprecated":false},{"title":"/configurations/qualification/{configurationId}","summary":"Read Tax Guard Identifier Qualification Configuration","prefix":{"name":"get","color":"get"},"badges":[{"name":"BETA","color":"blue","position":"after"}],"link":"/configuration/paths/~1configurations~1qualification~1{configurationid}/get","deprecated":false},{"title":"/configurations/qualification/{configurationId}/versions/{version}","summary":"Read Tax Guard Identifier Qualification Configuration Version","prefix":{"name":"get","color":"get"},"badges":[{"name":"BETA","color":"blue","position":"after"}],"link":"/configuration/paths/~1configurations~1qualification~1{configurationid}~1versions~1{version}/get","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/DataDefect":{"id":"components/schemas/DataDefect","kind":"json-schema","title":"DataDefect","data":{"type":"object","description":"A data defect is a data quality issue that was found in a record.\nIt contains information about the defect and the rule that found it.\n","properties":{"properties":{"type":"array","description":"Properties which caused the data defect.","items":{"$ref":"#/components/schemas/Property"}},"validationSource":{"$ref":"#/components/schemas/ValidationSource"},"businessRule":{"$ref":"#/components/schemas/BusinessRule"},"violationLevel":{"$ref":"#/components/schemas/ViolationLevel"},"violationMessage":{"type":"string","description":"Violation message that is returned with detected data defect.","example":"Business Partner identifier is mandatory."},"reason":{"type":"string","description":"Reason of the Data Defect occurrence.","example":"Identifier is mandatory."},"categories":{"type":"array","description":"List of categories the rule belongs to.","items":{"$ref":"#/components/schemas/RuleCategory"}},"errorCode":{"type":"number","description":"Error code of the data defect.","example":"400"}}}},"components/schemas/SingleRecordValidationRequest":{"id":"components/schemas/SingleRecordValidationRequest","kind":"json-schema","title":"SingleRecordValidationRequest","data":{"type":"object","description":"Request for validation of a single record.","allOf":[{"$ref":"#/components/schemas/RecordValidationRequest"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request for validation of a single record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For single request you can provide only one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jsonRecord"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one can be supported at a time,"},"children":[]}]}]}],"properties":{"jsonRecord":{"type":"object","description":"Stringified JSON of the custom record.","additionalProperties":true,"example":"{}"},"record":{"type":"string","description":"Stringified JSON of the custom record","example":"{}"},"externalId":{"type":"string","description":"Unique ID from the client system.","example":"A12345"}}}]}},"components/schemas/RecordValidationResult":{"id":"components/schemas/RecordValidationResult","kind":"json-schema","title":"RecordValidationResult","data":{"type":"object","description":"Contains information about created record during Validation Process.","properties":{"dataDefects":{"type":"array","description":"List of Data Defects found in the record.","items":{"$ref":"#/components/schemas/DataDefect"}},"decisions":{"type":"array","description":"List of Decisions made by the automation rules.","items":{"$ref":"#/components/schemas/Decision"}},"qualificationResult":{"$ref":"#/components/schemas/QualificationResult"},"summary":{"$ref":"#/components/schemas/ValidationSummary"},"debugInfo":{"$ref":"#/components/schemas/DebugInfo"},"diff":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable only for Record Validation when feature "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENRICH_DATA_MIRROR_CHANGES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled. Contains differences between value stored in CDQ storage and the value that was sent with the request."},"children":[]}]}]}],"example":"{\"Identified_changes\":[{\"op\":\"add\",\"path\":\"/partner/header/objectTask\",\"value\":\"C\"}]}"},"businessPartner":{"$ref":"#/components/schemas/BusinessPartner3"}}}},"components/schemas/BusinessPartnerChunkItemResult":{"id":"components/schemas/BusinessPartnerChunkItemResult","kind":"json-schema","title":"BusinessPartnerChunkItemResult","data":{"type":"object","description":"Contains information about created record during Validation Process.","properties":{"externalId":{"type":"string","description":"Refers to the externalId of the provided Business Partner.","example":"A12345"},"businessPartnerId":{"type":"string","description":"Refers to the id of the provided Business Partner.","example":"12312dc000572b1594f3f000"},"validationResult":{"$ref":"#/components/schemas/BusinessPartnerValidationResult"}}}},"components/schemas/BusinessPartnerChunkValidationWithQualificationResult":{"id":"components/schemas/BusinessPartnerChunkValidationWithQualificationResult","kind":"json-schema","title":"BusinessPartnerChunkValidationWithQualificationResult","data":{"type":"object","description":"Contains information about created record during Validation Process.","properties":{"results":{"type":"array","description":"List of results for each Business Partner in the chunk.","items":{"$ref":"#/components/schemas/BusinessPartnerChunkItemWithQualification"}}}}},"components/schemas/BusinessPartnerChunkItemWithQualification":{"id":"components/schemas/BusinessPartnerChunkItemWithQualification","kind":"json-schema","title":"BusinessPartnerChunkItemWithQualification","data":{"type":"object","description":"Item result with qualification information.","allOf":[{"$ref":"#/components/schemas/BusinessPartnerChunkItemResult"},{"type":"object","description":"Temporary object for qualificationV3.","properties":{"qualificationV3":{"$ref":"#/components/schemas/BusinessPartnerQualificationSummary"}}}]}},"components/schemas/BusinessPartnerQualificationSummary":{"id":"components/schemas/BusinessPartnerQualificationSummary","kind":"json-schema","title":"BusinessPartnerQualificationSummary","data":{"type":"object","description":"Summary of the Business Partner qualification result without the full Business Partner object.","properties":{"qualificationResults":{"type":"array","description":"List of Qualifications Results.","items":{"$ref":"#/components/schemas/BusinessPartnerQualificationResultItem"}},"rulesInError":{"$ref":"#/components/schemas/RulesInError"},"debugInfo":{"$ref":"#/components/schemas/DebugInfo"}}}},"components/schemas/BusinessPartner3":{"id":"components/schemas/BusinessPartner3","kind":"json-schema","title":"BusinessPartner3","data":{"type":"object","description":"An organization which has some degree of involvement with another organization's business dealings. Typically, a company's business partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the business partner is the core managed entity. A business partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a business partner.","properties":{"names":{"type":"array","description":"List of names of the Business Partner.","items":{"$ref":"#/components/schemas/Name2"}},"legalForm":{"$ref":"#/components/schemas/LegalForm2"},"identifiers":{"type":"array","description":"List of identifiers of the Business Partner.","items":{"$ref":"#/components/schemas/Identifier2"}},"categories":{"type":"array","description":"List of categories of the Business Partner.","items":{"$ref":"#/components/schemas/BusinessPartnerCategory2"}},"status":{"$ref":"#/components/schemas/BusinessPartnerStatus2"},"addresses":{"type":"array","description":"List of addresses of the Business Partner.","items":{"$ref":"#/components/schemas/Address3"}},"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"profile":{"$ref":"#/components/schemas/PartnerProfile"},"formattedSapRecord":{"$ref":"#/components/schemas/FormattedSapRecord"},"relations":{"type":"array","description":"List of relations of the Business Partner.","items":{"$ref":"#/components/schemas/BusinessPartnerRelation"}},"bankAccounts":{"type":"array","description":"List of bank accounts of the Business Partner.","items":{"$ref":"#/components/schemas/BankAccount2"}},"types":{"type":"array","description":"List of types of the Business Partner.","items":{"$ref":"#/components/schemas/BusinessPartnerType"}},"externalContext":{"$ref":"#/components/schemas/ExternalContext"},"id":{"$ref":"#/components/schemas/BusinessPartnerId"},"lastModifiedAt":{"$ref":"#/components/schemas/ModifiedAt"}}}},"components/schemas/Name2":{"id":"components/schemas/Name2","kind":"json-schema","title":"Name2","data":{"type":"object","description":"The name of a Business Partner.","example":"Corporate Data Quality AG","properties":{"shortName":{"$ref":"#/components/schemas/NameShortName"},"type":{"$ref":"#/components/schemas/NameType"},"value":{"$ref":"#/components/schemas/NameValue"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/NameType":{"id":"components/schemas/NameType","kind":"json-schema","title":"NameType","data":{"type":"object","description":"The type of the name, e.g. a locally used name or an international version.","example":"Local Name","properties":{"url":{"$ref":"#/components/schemas/NameTypeUrl"},"name":{"$ref":"#/components/schemas/NameTypeName"},"technicalKey":{"$ref":"#/components/schemas/NameTypeTechnicalKey"}}}},"components/schemas/LegalForm2":{"id":"components/schemas/LegalForm2","kind":"json-schema","title":"LegalForm2","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal Form of a Business Partner is the form it takes in the eyes of the law governing it. The legal form of a Business Partner is the general type it may legally use to identify itself according to the local, regional, national, or international law governing it. This is normally reflected in the ending abbreviation after the Business Partner's name (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Inc."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LLC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S.A."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"Aktiengesellschaft","properties":{"name":{"$ref":"#/components/schemas/LegalFormName"},"language":{"$ref":"#/components/schemas/Language"},"mainAbbreviation":{"$ref":"#/components/schemas/LegalFormMainAbbreviation"},"cdlElfCode":{"$ref":"#/components/schemas/LegalFormCdlElfCode"},"categories":{"type":"array","description":"List of categories of the Legal Form.","items":{"$ref":"#/components/schemas/LegalFormCategory"}},"url":{"$ref":"#/components/schemas/LegalFormUrl"},"technicalKey":{"$ref":"#/components/schemas/LegalFormTechnicalKey"}}}},"components/schemas/Language":{"id":"components/schemas/Language","kind":"json-schema","title":"Language","data":{"type":"object","description":"Naming of a language according to ISO 639-1.","properties":{"name":{"$ref":"#/components/schemas/LanguageName"},"technicalKey":{"$ref":"#/components/schemas/LanguageTechnicalKey"}}}},"components/schemas/LegalFormCategory":{"id":"components/schemas/LegalFormCategory","kind":"json-schema","title":"LegalFormCategory","data":{"type":"object","description":"The categorization of a Legal Form.","properties":{"name":{"$ref":"#/components/schemas/LegalFormCategoryName"},"shortName":{"$ref":"#/components/schemas/LegalFormCategoryShortName"},"url":{"$ref":"#/components/schemas/LegalFormCategoryUrl"},"technicalKey":{"$ref":"#/components/schemas/LegalFormCategoryTechnicalKey"}}}},"components/schemas/Identifier2":{"id":"components/schemas/Identifier2","kind":"json-schema","title":"Identifier2","data":{"type":"object","description":"Identifies a Business Partner in a given context uniquely such as a VAT identification number.","example":"VAT identification number","properties":{"value":{"$ref":"#/components/schemas/schemas-IdentifierValue"},"type":{"$ref":"#/components/schemas/IdentifierType2"},"status":{"$ref":"#/components/schemas/IdentifierStatus"},"issuingBody":{"$ref":"#/components/schemas/IssuingBody2"}}}},"components/schemas/IdentifierType2":{"id":"components/schemas/IdentifierType2","kind":"json-schema","title":"IdentifierType2","data":{"type":"object","description":"Type of the identifier.","example":"CH_VAT_ID","properties":{"url":{"$ref":"#/components/schemas/IdentifierTypeUrl"},"name":{"$ref":"#/components/schemas/IdentifierTypeName"},"technicalKey":{"$ref":"#/components/schemas/schemas-IdentifierTypeTechnicalKey"}}}},"components/schemas/IdentifierStatus":{"id":"components/schemas/IdentifierStatus","kind":"json-schema","title":"IdentifierStatus","data":{"type":"object","description":"Identifier Status refers to the current state of a unique identification number.","example":"ACTIVE","properties":{"name":{"$ref":"#/components/schemas/IdentifierStatusName"},"url":{"$ref":"#/components/schemas/IdentifierStatusTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/IdentifierStatusTechnicalKey"}}}},"components/schemas/IssuingBody2":{"id":"components/schemas/IssuingBody2","kind":"json-schema","title":"IssuingBody2","data":{"type":"object","description":"An Issuing Body is an organization or government institution that is responsible for assigning unique identifiers to individuals, organizations, or objects.","example":"Amtsgericht Aachen","properties":{"name":{"$ref":"#/components/schemas/IssuingBodyName"},"description":{"$ref":"#/components/schemas/IssuingBodyDescription"},"url":{"$ref":"#/components/schemas/IssuingBodyUrl"},"technicalKey":{"$ref":"#/components/schemas/IssuingBodyTechnicalKey"},"jurisdiction":{"$ref":"#/components/schemas/Jurisdiction2"},"gleifCode":{"$ref":"#/components/schemas/IssuingBodyGleifCode"},"localAuthorityCode":{"$ref":"#/components/schemas/IssuingBodyLocalAuthorityCode"},"externalUrl":{"$ref":"#/components/schemas/IssuingBodyExternalUrl"}}}},"components/schemas/Jurisdiction2":{"id":"components/schemas/Jurisdiction2","kind":"json-schema","title":"Jurisdiction2","data":{"type":"object","description":"The authority of an official organization to make decisions and judgments in a particular administrative area.","example":"Switzerland","properties":{"country":{"$ref":"#/components/schemas/Country2"},"administrativeAreas":{"type":"array","items":{"$ref":"#/components/schemas/AdministrativeArea2"}}}}},"components/schemas/Country2":{"id":"components/schemas/Country2","kind":"json-schema","title":"Country2","data":{"type":"object","description":"Country consisting of the country name and country code (ISO 3166-1 alpha-2).","example":"Switzerland CH","properties":{"shortName":{"$ref":"#/components/schemas/CountryShortName"},"value":{"$ref":"#/components/schemas/CountryValue"}}}},"components/schemas/AdministrativeArea2":{"id":"components/schemas/AdministrativeArea2","kind":"json-schema","title":"AdministrativeArea2","data":{"type":"object","description":"A top-level geographical or political area division in a country.","example":"Sankt Gallen","properties":{"value":{"$ref":"#/components/schemas/AdministrativeAreaValue"},"shortName":{"$ref":"#/components/schemas/AdministrativeAreaShortName"},"fipsCode":{"$ref":"#/components/schemas/AdministrativeAreaFipsCode"},"isoCode":{"$ref":"#/components/schemas/AdministrativeAreaIsoCode"},"type":{"$ref":"#/components/schemas/AdministrativeAreaType2"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/AdministrativeAreaType2":{"id":"components/schemas/AdministrativeAreaType2","kind":"json-schema","title":"AdministrativeAreaType2","data":{"type":"object","description":"Type of the Administrative Area.","properties":{"name":{"$ref":"#/components/schemas/AdministrativeAreaTypeName"},"url":{"$ref":"#/components/schemas/AdministrativeAreaTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/AdministrativeAreaTypeTechnicalKey"}}}},"components/schemas/BusinessPartnerCategory2":{"id":"components/schemas/BusinessPartnerCategory2","kind":"json-schema","title":"BusinessPartnerCategory2","data":{"type":"object","description":"A business partner category of a business partner groups similar business partners.","example":"Hotel","properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerCategoryName"},"url":{"$ref":"#/components/schemas/BusinessPartnerCategoryUrl"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerCategoryTechnicalKey"}}}},"components/schemas/BusinessPartnerStatus2":{"id":"components/schemas/BusinessPartnerStatus2","kind":"json-schema","title":"BusinessPartnerStatus2","data":{"type":"object","description":"Describes the status of a business partner with respect to its level of activity (e.g. out of business) or legally relevant conditions (e.g. in liquidation).","properties":{"officialDenotation":{"$ref":"#/components/schemas/BusinessPartnerStatusOfficialDenotation"},"validFrom":{"$ref":"#/components/schemas/BusinessPartnerStatusValidFrom"},"validUntil":{"$ref":"#/components/schemas/BusinessPartnerStatusValidUntil"},"type":{"$ref":"#/components/schemas/BusinessPartnerStatusType2"}}}},"components/schemas/BusinessPartnerStatusType2":{"id":"components/schemas/BusinessPartnerStatusType2","kind":"json-schema","title":"BusinessPartnerStatusType2","data":{"type":"object","description":"The standardized status which the business partner currently has.","example":"In Liquidation","properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerStatusTypeName"},"url":{"$ref":"#/components/schemas/BusinessPartnerStatusTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerStatusTypeTechnicalKey"}}}},"components/schemas/Address3":{"id":"components/schemas/Address3","kind":"json-schema","title":"Address3","data":{"type":"object","description":"An address provides information about the physical location of a business partner. It can be specialized in a certain context(e.g. delivery address or invoice address).","example":"Lukasstraße 4, 9008 St. Gallen","properties":{"version":{"$ref":"#/components/schemas/AddressVersion"},"identifyingName":{"$ref":"#/components/schemas/AddressIdentifyingName"},"externalId":{"$ref":"#/components/schemas/AddressExternalId"},"metadata":{"$ref":"#/components/schemas/AddressMetadata"},"careOf":{"$ref":"#/components/schemas/CareOf"},"contexts":{"type":"array","description":"List of Address contexts.","items":{"$ref":"#/components/schemas/AddressContext"}},"country":{"$ref":"#/components/schemas/Country2"},"administrativeAreas":{"type":"array","description":"List of Administrative Areas.","items":{"$ref":"#/components/schemas/AdministrativeArea2"}},"postCodes":{"type":"array","description":"List of Post Codes.","items":{"$ref":"#/components/schemas/PostCode2"}},"localities":{"type":"array","description":"List of Localities.","items":{"$ref":"#/components/schemas/Locality2"}},"thoroughfares":{"type":"array","description":"List of Thoroughfares.","items":{"$ref":"#/components/schemas/Thoroughfare2"}},"premises":{"type":"array","description":"List of Premises.","items":{"$ref":"#/components/schemas/Premise2"}},"postalDeliveryPoints":{"type":"array","description":"List of Postal Delivery Points.","items":{"$ref":"#/components/schemas/PostalDeliveryPoint2"}},"openingHours":{"type":"array","description":"List of Opening Hours.","items":{"$ref":"#/components/schemas/OpeningHour"}},"geographicCoordinates":{"$ref":"#/components/schemas/GeographicCoordinates2"},"types":{"type":"array","description":"List of types of the Address.","items":{"$ref":"#/components/schemas/AddressType2"}},"formattedAddress":{"$ref":"#/components/schemas/FormattedAddress"}}}},"components/schemas/AddressVersion":{"id":"components/schemas/AddressVersion","kind":"json-schema","title":"AddressVersion","data":{"type":"object","description":"CDQ supports multiple versions of addresses comprising different charsets and languages. An address version is a unique combination of a character set and a language.","example":"International DE","properties":{"characterSet":{"$ref":"#/components/schemas/CharacterSet"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/AddressIdentifyingName":{"id":"components/schemas/AddressIdentifyingName","kind":"json-schema","title":"AddressIdentifyingName","data":{"type":"object","description":"An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent.","example":"John Doe","properties":{"value":{"$ref":"#/components/schemas/AddressIdentifyingNameValue"}}}},"components/schemas/AddressMetadata":{"id":"components/schemas/AddressMetadata","kind":"json-schema","title":"AddressMetadata","data":{"type":"object","description":"Specifies the language and primary data provenance.","example":"DE, Google","properties":{"primaryProvenance":{"$ref":"#/components/schemas/Provenance"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/Provenance":{"id":"components/schemas/Provenance","kind":"json-schema","title":"Provenance","data":{"type":"object","description":"The source of the change/update. Could be the reference data source as VIES or Organization.","properties":{"name":{"$ref":"#/components/schemas/ProvenanceName"},"url":{"$ref":"#/components/schemas/ProvenanceUrl"},"technicalKey":{"$ref":"#/components/schemas/ProvenanceTechnicalKey"},"cdqId":{"$ref":"#/components/schemas/ProvenanceCdqId"}}}},"components/schemas/CareOf":{"id":"components/schemas/CareOf","kind":"json-schema","title":"CareOf","data":{"type":"object","description":"Signifies an intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example, when the addressee has no standard address, is under a corporate mail system, or is being manually forwarded mail sent to a more accessible location.","example":"CDQ GmbH c/o Product Department","properties":{"value":{"$ref":"#/components/schemas/CareOfValue"}}}},"components/schemas/AddressContext":{"id":"components/schemas/AddressContext","kind":"json-schema","title":"AddressContext","data":{"type":"object","description":"The address context provides us with some additional information about the usage or specific recipient information of the addresses. It may hold multiple information organized as \"tags\".","example":"Production hall 7, Storage field 8.","properties":{"value":{"$ref":"#/components/schemas/AddressContextValue"}}}},"components/schemas/PostCode2":{"id":"components/schemas/PostCode2","kind":"json-schema","title":"PostCode2","data":{"type":"object","description":"A country specific code for a certain address component or an combination of address components, e.g. locality.","example":"9000","properties":{"value":{"$ref":"#/components/schemas/PostCodeValue"},"type":{"$ref":"#/components/schemas/PostCodeType"}}}},"components/schemas/PostCodeType":{"id":"components/schemas/PostCodeType","kind":"json-schema","title":"PostCodeType","data":{"type":"object","description":"Type of the Post Code.","properties":{"name":{"$ref":"#/components/schemas/PostCodeTypeName"},"url":{"$ref":"#/components/schemas/PostCodeTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/PostCodeTypeTechnicalKey"}}}},"components/schemas/Locality2":{"id":"components/schemas/Locality2","kind":"json-schema","title":"Locality2","data":{"type":"object","description":"A locality is a named densely populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses. Many localities exist in an administrative area. A locality can also have several levels of sub localities.","example":"Sankt Gallen","properties":{"type":{"$ref":"#/components/schemas/LocalityType"},"shortName":{"$ref":"#/components/schemas/LocalityShortName"},"value":{"$ref":"#/components/schemas/LocalityValue"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/LocalityType":{"id":"components/schemas/LocalityType","kind":"json-schema","title":"LocalityType","data":{"type":"object","description":"Type of the Locality.","example":"City","properties":{"name":{"$ref":"#/components/schemas/LocalityTypeName"},"url":{"$ref":"#/components/schemas/LocalityTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/LocalityTypeTechnicalKey"}}}},"components/schemas/Thoroughfare2":{"id":"components/schemas/Thoroughfare2","kind":"json-schema","title":"Thoroughfare2","data":{"type":"object","description":"Details of the access route along which buildings, lots, or land are located, such as street, road, channel, crescent, avenue, etc. This also includes canals or banks on which houses or boat houses are located where people live.","example":"Lukasstraße 4","properties":{"type":{"$ref":"#/components/schemas/ThoroughfareType"},"shortName":{"$ref":"#/components/schemas/ThoroughfareShortName"},"number":{"$ref":"#/components/schemas/ThoroughfareNumber"},"value":{"$ref":"#/components/schemas/ThoroughfareValue"},"name":{"$ref":"#/components/schemas/ThoroughfareName"},"direction":{"$ref":"#/components/schemas/ThoroughfareDirection"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/ThoroughfareType":{"id":"components/schemas/ThoroughfareType","kind":"json-schema","title":"ThoroughfareType","data":{"type":"object","description":"Type of the Thoroughfare.","example":"Industrial zone","properties":{"name":{"$ref":"#/components/schemas/ThoroughfareTypeName"},"url":{"$ref":"#/components/schemas/ThoroughfareTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/ThoroughfareTypeTechnicalKey"}}}},"components/schemas/Premise2":{"id":"components/schemas/Premise2","kind":"json-schema","title":"Premise2","data":{"type":"object","description":"A premise is a tract of land including its buildings. A premise may have several sub-levels to precisely identify.","example":"Lukasstraße 4, Building 2, Floor 3, Room 4","properties":{"value":{"$ref":"#/components/schemas/PremiseValue"},"shortName":{"$ref":"#/components/schemas/PremiseShortName"},"number":{"$ref":"#/components/schemas/PremiseNumber"},"type":{"$ref":"#/components/schemas/PremiseType2"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/PremiseType2":{"id":"components/schemas/PremiseType2","kind":"json-schema","title":"PremiseType2","data":{"type":"object","description":"Type of the Premise.","example":"Building","properties":{"name":{"$ref":"#/components/schemas/PremiseTypeName"},"url":{"$ref":"#/components/schemas/PremiseTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/PremiseTypeTechnicalKey"}}}},"components/schemas/PostalDeliveryPoint2":{"id":"components/schemas/PostalDeliveryPoint2","kind":"json-schema","title":"PostalDeliveryPoint2","data":{"type":"object","description":"A single mailbox or other place at which postal mail is delivered.","example":"Sankt Gallen, Postfach 460","properties":{"type":{"$ref":"#/components/schemas/PostalDeliveryPointType2"},"shortName":{"$ref":"#/components/schemas/PostalDeliveryPointShortName"},"number":{"$ref":"#/components/schemas/PostalDeliveryPointNumber"},"value":{"$ref":"#/components/schemas/PostalDeliveryPointValue"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/PostalDeliveryPointType2":{"id":"components/schemas/PostalDeliveryPointType2","kind":"json-schema","title":"PostalDeliveryPointType2","data":{"type":"object","description":"A single mailbox or other place at which postal mail is delivered.","example":"Sankt Gallen, Postfach 460","properties":{"name":{"$ref":"#/components/schemas/PostalDeliveryPointTypeName"},"url":{"$ref":"#/components/schemas/PostalDeliveryPointTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/PostalDeliveryPointTypeTechnicalKey"}}}},"components/schemas/GeographicCoordinates2":{"id":"components/schemas/GeographicCoordinates2","kind":"json-schema","title":"GeographicCoordinates2","data":{"type":"object","description":"Decimal geographic coordinates (WGS 84 - reference coordinate system).","example":"47.439549, 9.395275","properties":{"latitude":{"$ref":"#/components/schemas/GeographicCoordinatesLatitude"},"longitude":{"$ref":"#/components/schemas/GeographicCoordinatesLongitude"}}}},"components/schemas/AddressType2":{"id":"components/schemas/AddressType2","kind":"json-schema","title":"AddressType2","data":{"type":"object","description":"An address type characterizes an address. The type of address is a structural statement and provides a truth that is applicable to any user (e.g. a legal address is a fact, or that an address is a PO BOX address), other than address functions that may differ from user to user. Address functions determine the particular business context in which an address is in use.","example":"Legal Address","properties":{"name":{"$ref":"#/components/schemas/AddressTypeName"},"url":{"$ref":"#/components/schemas/AddressTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/AddressTypeTechnicalKey"}}}},"components/schemas/FormattedAddress":{"id":"components/schemas/FormattedAddress","kind":"json-schema","title":"FormattedAddress","data":{"type":"object","description":"A formatted address is a structured address of VIES data source.","properties":{"country":{"$ref":"#/components/schemas/FormattedAddressCountry"},"administrativeArea":{"$ref":"#/components/schemas/FormattedAddressAdministrativeArea"},"region":{"$ref":"#/components/schemas/FormattedAddressRegion"},"regionCode":{"$ref":"#/components/schemas/FormattedAddressRegionCode"},"locality":{"$ref":"#/components/schemas/FormattedAddressLocality"},"district":{"$ref":"#/components/schemas/FormattedAddressDistrict"},"postalCode":{"$ref":"#/components/schemas/FormattedAddressPostalCode"},"thoroughfare":{"$ref":"#/components/schemas/FormattedAddressThoroughfare"},"premise":{"$ref":"#/components/schemas/FormattedAddressPremise"},"interurbanDeliveryPoint":{"$ref":"#/components/schemas/FormattedAddressInterurbanDeliveryPoint"},"mailbox":{"$ref":"#/components/schemas/FormattedAddressMailbox"},"postOfficeBox":{"$ref":"#/components/schemas/FormattedAddressPostOfficeBox"}}}},"components/schemas/PartnerProfile":{"id":"components/schemas/PartnerProfile","kind":"json-schema","title":"PartnerProfile","data":{"description":"A business partner profile contains important information about a company, such as its classification, tags, contact details, or minority indicator.","type":"object","properties":{"minorityIndicator":{"$ref":"#/components/schemas/MinorityIndicator"},"classifications":{"type":"array","items":{"$ref":"#/components/schemas/Classification"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"}},"websites":{"type":"array","items":{"$ref":"#/components/schemas/Website"}},"contactEmails":{"type":"array","items":{"$ref":"#/components/schemas/ContactEmail"}},"tags":{"$ref":"#/components/schemas/Tags"}}}},"components/schemas/MinorityIndicator":{"id":"components/schemas/MinorityIndicator","kind":"json-schema","title":"MinorityIndicator","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minority indicator determines the minority group to which a vendor belongs. Usually, the minority indicator is only relevant in the United States and it is used for reporting purposes only. There is a corresponding SAP field in the vendor master for maintaining the minority indicator."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is as of today dependent on data provided by a US based company: SupplierGateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For businesses, the minority indicator is often required in the context of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Government Contracts: Businesses must disclose if they are minority-owned, which can qualify them for certain federal, state, or local government contracts reserved for minority-owned businesses."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Diversity Reporting: Companies may use minority indicators to track the diversity of their workforce, ensuring compliance with regulations such as the Equal Employment Opportunity (EEO) laws."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supplier Diversity Programs: Large corporations often track minority-owned businesses in their supply chains as part of their supplier diversity initiatives."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The indicators can pertain to various minority groups, such as:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"racial and ethnic minorities (e.g., African American, Hispanic, Asian American, Native American),"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"women,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"veterans"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"people with disabilities."},"children":[]}]}]}]}],"type":"object","example":"Social enterprise","properties":{"value":{"$ref":"#/components/schemas/MinorityIndicatorValue"}}}},"components/schemas/Classification":{"id":"components/schemas/Classification","kind":"json-schema","title":"Classification","data":{"type":"object","description":"A business industry or activity classification is a system of categorizing businesses and organizations into specific industries or activities based on their primary products or services, functions, or activities. These classifications are often used by governments, trade organizations, and other institutions to collect and analyze data on economic activity and to track trends and changes in various sectors.","example":"NAF","properties":{"value":{"$ref":"#/components/schemas/ClassificationValue"},"code":{"$ref":"#/components/schemas/ClassificationCode"},"level":{"$ref":"#/components/schemas/ClassificationLevel"},"type":{"$ref":"#/components/schemas/ClassificationType"}}}},"components/schemas/PhoneNumber":{"id":"components/schemas/PhoneNumber","kind":"json-schema","title":"PhoneNumber","data":{"type":"object","description":"The main phone number of a business partner, usually some info-line of the headquarter.","example":"+41 71 571 10 40","properties":{"countryPrefix":{"$ref":"#/components/schemas/PhoneNumberCountryPrefix"},"number":{"$ref":"#/components/schemas/PhoneNumberNumber"},"type":{"$ref":"#/components/schemas/PhoneNumberType"},"value":{"$ref":"#/components/schemas/PhoneNumberValue"}}}},"components/schemas/Website":{"id":"components/schemas/Website","kind":"json-schema","title":"Website","data":{"type":"object","description":"Webpages related to the business partner, e.g. the main corporate website as also provided by some company registers.","example":"www.cdq.com","properties":{"url":{"$ref":"#/components/schemas/WebsiteUrl"},"type":{"$ref":"#/components/schemas/schemas-WebsiteType"}}}},"components/schemas/ContactEmail":{"id":"components/schemas/ContactEmail","kind":"json-schema","title":"ContactEmail","data":{"type":"object","description":"Actual email address of the Business Partner.","example":"developer-portal@cdq.com","properties":{"value":{"$ref":"#/components/schemas/ContactEmailValue"}}}},"components/schemas/FormattedSapRecord":{"id":"components/schemas/FormattedSapRecord","kind":"json-schema","title":"FormattedSapRecord","data":{"description":"Provides business partner and address information in a data structure similar to SAP Business Partner table BUT000 and SAP Business Address Services table ADRC. Field names are equal or very similar to SAP field names in order to simplify field mapping. Data for name and street fields is already split into chunks of max. 35 characters.","type":"object","properties":{"name1":{"$ref":"#/components/schemas/FormattedSapRecordName1"},"name2":{"$ref":"#/components/schemas/FormattedSapRecordName2"},"name3":{"$ref":"#/components/schemas/FormattedSapRecordName3"},"name4":{"$ref":"#/components/schemas/FormattedSapRecordName4"},"nameCo":{"$ref":"#/components/schemas/FormattedSapRecordNameCo"},"legalEntity":{"$ref":"#/components/schemas/FormattedSapRecordLegalEntity"},"legalForm":{"$ref":"#/components/schemas/FormattedSapRecordLegalForm"},"indSector":{"$ref":"#/components/schemas/FormattedSapRecordIndSector"},"narp":{"$ref":"#/components/schemas/FormattedSapRecordNarp"},"stceg":{"$ref":"#/components/schemas/FormattedSapRecordStceg"},"stcd1":{"$ref":"#/components/schemas/FormattedSapRecordStcd1"},"stcd2":{"$ref":"#/components/schemas/FormattedSapRecordStcd2"},"stcd3":{"$ref":"#/components/schemas/FormattedSapRecordStcd3"},"stcd4":{"$ref":"#/components/schemas/FormattedSapRecordStcd4"},"stcd5":{"$ref":"#/components/schemas/FormattedSapRecordStcd5"},"url":{"$ref":"#/components/schemas/FormattedSapRecordUrl"},"telNumber":{"$ref":"#/components/schemas/FormattedSapRecordTelNumber"},"country":{"$ref":"#/components/schemas/FormattedSapRecordCountry"},"countryCode":{"$ref":"#/components/schemas/FormattedSapRecordCountryCode"},"region":{"$ref":"#/components/schemas/FormattedSapRecordRegion"},"regionCodeSap":{"$ref":"#/components/schemas/FormattedSapRecordRegionCodeSap"},"regionCode":{"$ref":"#/components/schemas/FormattedSapRecordRegionCode"},"county":{"$ref":"#/components/schemas/FormattedSapRecordCounty"},"countyCode":{"$ref":"#/components/schemas/FormattedSapRecordCountyCode"},"township":{"$ref":"#/components/schemas/FormattedSapRecordTownship"},"townshipCode":{"$ref":"#/components/schemas/FormattedSapRecordTownshipCode"},"city":{"$ref":"#/components/schemas/FormattedSapRecordCity"},"district":{"$ref":"#/components/schemas/FormattedSapRecordDistrict"},"postalCode":{"$ref":"#/components/schemas/FormattedSapRecordPostalCode"},"postalCode3":{"$ref":"#/components/schemas/FormattedSapRecordPostalCode3"},"street1":{"$ref":"#/components/schemas/FormattedSapRecordStreet1"},"street2":{"$ref":"#/components/schemas/FormattedSapRecordStreet2"},"street5":{"$ref":"#/components/schemas/FormattedSapRecordStreet5"},"houseNum":{"$ref":"#/components/schemas/FormattedSapRecordHouseNum"},"houseNum2":{"$ref":"#/components/schemas/FormattedSapRecordHouseNum2"},"building":{"$ref":"#/components/schemas/FormattedSapRecordBuilding"},"floor":{"$ref":"#/components/schemas/FormattedSapRecordFloor"},"roomnumber":{"$ref":"#/components/schemas/FormattedSapRecordRoomnumber"},"poBoxCountry":{"$ref":"#/components/schemas/FormattedSapRecordPoBoxCountry"},"poBoxCity":{"$ref":"#/components/schemas/FormattedSapRecordPoBoxCity"},"poBoxPostalCode":{"$ref":"#/components/schemas/FormattedSapRecordPoBoxPostalCode"},"poBox":{"$ref":"#/components/schemas/FormattedSapRecordPoBox"},"latitude":{"$ref":"#/components/schemas/FormattedSapRecordLatitude"},"longitude":{"$ref":"#/components/schemas/FormattedSapRecordLongitude"}}}},"components/schemas/BusinessPartnerRelation":{"id":"components/schemas/BusinessPartnerRelation","kind":"json-schema","title":"BusinessPartnerRelation","data":{"type":"object","description":"Business Partner hierarchy, or any other kind of relation between two Business Partner entities. The data about relationships between companies come from official, external data sources.","example":"Commercial ultimate","properties":{"startedAt":{"$ref":"#/components/schemas/BusinessPartnerRelationStartedAt"},"endedAt":{"$ref":"#/components/schemas/BusinessPartnerRelationEndedAt"},"type":{"$ref":"#/components/schemas/BusinessPartnerRelationType"},"class":{"$ref":"#/components/schemas/BusinessPartnerRelationClass"},"startNode":{"$ref":"#/components/schemas/BusinessPartnerRelationStartNode"},"endNode":{"$ref":"#/components/schemas/BusinessPartnerRelationEndNode"}}}},"components/schemas/BusinessPartnerRelationType":{"id":"components/schemas/BusinessPartnerRelationType","kind":"json-schema","title":"BusinessPartnerRelationType","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides information about the type of the relationship between two Business Partners like:\\ direct parent/child, ultimate parent, branch."},"children":[]}]}]}],"properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerRelationTypeName"},"url":{"$ref":"#/components/schemas/BusinessPartnerRelationTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerRelationTypeTechnicalKey"}}}},"components/schemas/BusinessPartnerRelationClass":{"id":"components/schemas/BusinessPartnerRelationClass","kind":"json-schema","title":"BusinessPartnerRelationClass","data":{"type":"object","description":"Provides information about the classification of the relation.","properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerRelationClassName"},"url":{"$ref":"#/components/schemas/BusinessPartnerRelationClassUrl"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerRelationClassTechnicalKey"}}}},"components/schemas/BankAccount2":{"id":"components/schemas/BankAccount2","kind":"json-schema","title":"BankAccount2","data":{"type":"object","description":"A bank account record holds information that universally describes a registered bank account.","properties":{"internationalBankAccountIdentifier":{"$ref":"#/components/schemas/InternationalBankAccountIdentifier"},"internationalBankIdentifier":{"$ref":"#/components/schemas/InternationalBankIdentifier"},"nationalBankAccountIdentifier":{"$ref":"#/components/schemas/NationalBankAccountIdentifier"},"nationalBankIdentifier":{"$ref":"#/components/schemas/NationalBankIdentifier"},"bank":{"$ref":"#/components/schemas/Bank2"},"countryCode":{"$ref":"#/components/schemas/BankAccountCountryCode"}}}},"components/schemas/Bank2":{"id":"components/schemas/Bank2","kind":"json-schema","title":"Bank2","data":{"type":"object","description":"Financial institution that accepts deposits, facilitates withdrawals and transfers, and provides various financial services such as loans, investments, and currency exchange.","properties":{"name":{"$ref":"#/components/schemas/BankName"},"branch":{"$ref":"#/components/schemas/BankBranch"},"address":{"$ref":"#/components/schemas/BankAddress2"}}}},"components/schemas/BankAddress2":{"id":"components/schemas/BankAddress2","kind":"json-schema","title":"BankAddress2","data":{"type":"object","description":"The address where a bank resides.","properties":{"localities":{"type":"array","items":{"$ref":"#/components/schemas/Locality2"}},"country":{"$ref":"#/components/schemas/Country2"},"administrativeAreas":{"type":"array","items":{"$ref":"#/components/schemas/AdministrativeArea2"}},"postCodes":{"type":"array","items":{"$ref":"#/components/schemas/PostCode2"}},"thoroughfares":{"type":"array","items":{"$ref":"#/components/schemas/Thoroughfare2"}}}}},"components/schemas/BusinessPartnerType":{"id":"components/schemas/BusinessPartnerType","kind":"json-schema","title":"BusinessPartnerType","data":{"type":"object","description":"A distinct type a business partner is assigned to. It determines the business context a business partner is involved in. In the Corporate Data League, most business partners are legal entities.","properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerTypeName"},"url":{"$ref":"#/components/schemas/BusinessPartnerTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerTypeTechnicalKey"}}}},"components/schemas/ExternalContext":{"id":"components/schemas/ExternalContext","kind":"json-schema","title":"ExternalContext","data":{"type":"object","description":"Describe own identifiers of a record (others than just the external Id).","example":"LIFNR","properties":{"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/ExternalContextIdentifier"}}}}},"components/schemas/ExternalContextIdentifier":{"id":"components/schemas/ExternalContextIdentifier","kind":"json-schema","title":"ExternalContextIdentifier","data":{"type":"object","description":"Describe own identifiers of a record (others than just the external Id).","example":"LIFNR","properties":{"value":{"$ref":"#/components/schemas/ExternalContextIdentifierValue"},"type":{"$ref":"#/components/schemas/ExternalContextIdentifierType"}}}},"components/schemas/RuleCategory":{"id":"components/schemas/RuleCategory","kind":"json-schema","title":"RuleCategory","data":{"type":"object","description":"A rule category is a group of rules that are related to each other. Rule categories are used to filter rules by its category. If any value is present then only rules of given category will be promoted to execution.","properties":{"url":{"$ref":"#/components/schemas/RuleCategoryUrl"},"name":{"$ref":"#/components/schemas/RuleCategoryName"}}}},"components/schemas/RuleCategoryOn":{"id":"components/schemas/RuleCategoryOn","kind":"json-schema","title":"RuleCategoryOn","data":{"type":"object","description":"Used to filter rules by its category. If any value is present then only rules of given category will be promoted to execution.","properties":{"url":{"$ref":"#/components/schemas/RuleCategoryUrl"}}}},"components/schemas/RuleCategoryUrl":{"id":"components/schemas/RuleCategoryUrl","kind":"json-schema","title":"RuleCategoryUrl","data":{"type":"string","description":"URL of the rule category.","example":"N/A"}},"components/schemas/RuleCategoryName":{"id":"components/schemas/RuleCategoryName","kind":"json-schema","title":"RuleCategoryName","data":{"type":"string","description":"Name of the rule category.","example":"Identifier checkdigit"}},"components/schemas/BusinessPartnerParam":{"id":"components/schemas/BusinessPartnerParam","kind":"json-schema","title":"BusinessPartnerParam","data":{"type":"object","description":"Refers to an organizational entity engaged in various facets of another organization's business interactions. This collaborative connection often manifests as a customer, supplier, vendor, or service provider. In the CDQ (Corporate Data Quality) framework, the Business Partner assumes a pivotal role as a core managed entity. Each Business Partner is distinctly and globally identifiable through a unique CDQ ID. All pertinent information, including addresses, identifiers, and hierarchical data, is intricately associated with and linked to the specific Business Partner, ensuring comprehensive management and traceability within the system.","properties":{"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"names":{"type":"array","description":"List of names of the Business Partner.","items":{"$ref":"#/components/schemas/NameParam"}},"legalForm":{"$ref":"#/components/schemas/LegalFormParam"},"identifiers":{"type":"array","description":"List of identifiers of the Business Partner.","items":{"$ref":"#/components/schemas/IdentifierParam"}},"addresses":{"type":"array","description":"List of addresses of the Business Partner.","items":{"$ref":"#/components/schemas/Address2"}}}}},"components/schemas/Address2":{"id":"components/schemas/Address2","kind":"json-schema","title":"Address2","data":{"type":"object","description":"An address provides information about the physical location of a business partner. It can be specialized in a certain context(e.g. delivery address or invoice address).","properties":{"country":{"$ref":"#/components/schemas/CountryParam"},"thoroughfares":{"type":"array","description":"List of Thoroughfares.","items":{"$ref":"#/components/schemas/ThoroughfareParam"}},"postCodes":{"type":"array","description":"List of Post Codes.","items":{"$ref":"#/components/schemas/PostCodeParam"}},"localities":{"type":"array","description":"List of Localities.","items":{"$ref":"#/components/schemas/LocalityParam"}},"premises":{"type":"array","description":"List of Premises.","items":{"$ref":"#/components/schemas/PremiseParam"}},"administrativeAreas":{"type":"array","description":"List of Administrative Areas.","items":{"$ref":"#/components/schemas/AdministrativeAreaParam"}},"postalDeliveryPoints":{"type":"array","description":"List of Postal Delivery Points.","items":{"$ref":"#/components/schemas/PostalDeliveryPointParam"}}}}},"components/schemas/LegalFormParam":{"id":"components/schemas/LegalFormParam","kind":"json-schema","title":"LegalFormParam","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal Form of a Business Partner is the form it takes in the eyes of the law governing it. The legal form of a Business Partner is the general type it may legally use to identify itself according to the local, regional, national, or international law governing it. This is normally reflected in the ending abbreviation after the Business Partner's name (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Inc."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LLC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S.A."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"name":{"$ref":"#/components/schemas/LegalFormName"}}}},"components/schemas/PremiseParam":{"id":"components/schemas/PremiseParam","kind":"json-schema","title":"PremiseParam","data":{"type":"object","description":"A premise is a tract of land including its buildings. A premise may have several sub-levels to precisely identify.","properties":{"value":{"$ref":"#/components/schemas/PremiseValue"}}}},"components/schemas/LocalityParam":{"id":"components/schemas/LocalityParam","kind":"json-schema","title":"LocalityParam","data":{"type":"object","description":"A locality is a named densely populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses. Many localities exist in an administrative area. A locality can also have several levels of sub localities.","properties":{"value":{"$ref":"#/components/schemas/LocalityValue"}}}},"components/schemas/IdentifierParam":{"id":"components/schemas/IdentifierParam","kind":"json-schema","title":"IdentifierParam","data":{"type":"object","description":"Identifies a Business Partner in a given context uniquely such as a VAT identification number.","properties":{"value":{"$ref":"#/components/schemas/schemas-IdentifierValue"},"type":{"type":"object","description":"Type of the identifier.","properties":{"technicalKey":{"$ref":"#/components/schemas/schemas-IdentifierTypeTechnicalKey"}}}}}},"components/schemas/CountryParam":{"id":"components/schemas/CountryParam","kind":"json-schema","title":"CountryParam","data":{"type":"object","description":"Country consisting of the country name and country code (ISO 3166-1 alpha-2).","properties":{"shortName":{"$ref":"#/components/schemas/CountryShortName"},"value":{"$ref":"#/components/schemas/CountryValue"}}}},"components/schemas/ThoroughfareParam":{"id":"components/schemas/ThoroughfareParam","kind":"json-schema","title":"ThoroughfareParam","data":{"type":"object","description":"Details of the access route along which buildings, lots, or land are located, such as street, road, channel, crescent, avenue, etc. This also includes canals or banks on which houses or boat houses are located where people live.","properties":{"value":{"$ref":"#/components/schemas/ThoroughfareValue"}}}},"components/schemas/PostCodeParam":{"id":"components/schemas/PostCodeParam","kind":"json-schema","title":"PostCodeParam","data":{"type":"object","description":"A country specific code for a certain address component or a combination of address components, e.g. locality.","properties":{"value":{"$ref":"#/components/schemas/PostCodeValue"}}}},"components/schemas/RecordParam":{"id":"components/schemas/RecordParam","kind":"json-schema","title":"RecordParam","data":{"type":"object","description":"A single record to be validated.","properties":{"jsonRecord":{"type":"object","description":"Stringified JSON of the custom record.","additionalProperties":true},"record":{"type":"string","description":"Stringified test case data. If data and jsonRecord are present, exception will be thrown.","example":"{\\\"name\\\":\\\"demo\\\"}"},"externalId":{"type":"string","description":"Unique id from the client system.","example":"A12345"}}}},"components/schemas/RecordChunkItemResult":{"id":"components/schemas/RecordChunkItemResult","kind":"json-schema","title":"RecordChunkItemResult","data":{"type":"object","description":"Validation result of a single record.","properties":{"externalId":{"type":"string","description":"Binds record chunk item result to the record from data or jsonRecord of RecordParam.","example":"A12345"},"validationResult":{"$ref":"#/components/schemas/RecordValidationResult"}}}},"components/schemas/SingleBusinessPartnerValidationRequest":{"id":"components/schemas/SingleBusinessPartnerValidationRequest","kind":"json-schema","title":"SingleBusinessPartnerValidationRequest","data":{"type":"object","description":"Request for validation of a single business partner.","allOf":[{"$ref":"#/components/schemas/BusinessPartnerValidationRequest"},{"type":"object","description":"Request for validation of a single business partner.","required":["businessPartner"],"properties":{"businessPartner":{"$ref":"#/components/schemas/BusinessPartnerParam"}}}]}},"components/schemas/BusinessPartnerValidationJobResultPage":{"id":"components/schemas/BusinessPartnerValidationJobResultPage","kind":"json-schema","title":"BusinessPartnerValidationJobResultPage","data":{"type":"object","description":"Single page of results fetched from Job Result Storage that was populated with validation results made by Business Partner Validation Job.","properties":{"startAfter":{"$ref":"#/components/schemas/StartAfter"},"limit":{"$ref":"#/components/schemas/Limit"},"total":{"$ref":"#/components/schemas/PageTotal"},"values":{"type":"array","description":"List of validation results.","items":{"$ref":"#/components/schemas/BusinessPartnerValidationResult"}},"nextStartAfter":{"$ref":"#/components/schemas/NextStartAfter"}}}},"components/schemas/ProcessingLog":{"id":"components/schemas/ProcessingLog","kind":"json-schema","title":"ProcessingLog","data":{"type":"object","description":"Processing log data.","properties":{"id":{"$ref":"#/components/schemas/ProcessingLogId"},"trigger":{"$ref":"#/components/schemas/ProcessingLogTrigger"},"replyQueue":{"$ref":"#/components/schemas/ReplyQueue"}}}},"components/schemas/ProcessingLogId":{"id":"components/schemas/ProcessingLogId","kind":"json-schema","title":"ProcessingLogId","data":{"type":"string","description":"Processing log ID to which data should be upserted by worker. In the future, when processing log ID is provided, data is not upserted to job result storage.","example":"VALIDATION_LOG"}},"components/schemas/ProcessingLogTriggerType":{"id":"components/schemas/ProcessingLogTriggerType","kind":"json-schema","title":"ProcessingLogTriggerType","data":{"type":"string","description":"Processing log trigger type determining way how the validation item has been triggered.","example":"API"}},"components/schemas/ProcessingLogTrigger":{"id":"components/schemas/ProcessingLogTrigger","kind":"json-schema","title":"ProcessingLogTrigger","data":{"type":"object","description":"Processing log trigger.","properties":{"type":{"$ref":"#/components/schemas/ProcessingLogTriggerType"},"provenance":{"$ref":"#/components/schemas/ProcessingLogTriggerProvenance"},"details":{"$ref":"#/components/schemas/ProcessingLogTriggerDetails"}}}},"components/schemas/ProcessingLogTriggerProvenance":{"id":"components/schemas/ProcessingLogTriggerProvenance","kind":"json-schema","title":"ProcessingLogTriggerProvenance","data":{"type":"object","description":"Processing log trigger provenance.","properties":{"technicalKey":{"$ref":"#/components/schemas/ProvenanceTechnicalKey"},"cdqId":{"$ref":"#/components/schemas/ProvenanceCdqId"}}}},"components/schemas/ProcessingLogTriggerDetails":{"id":"components/schemas/ProcessingLogTriggerDetails","kind":"json-schema","title":"ProcessingLogTriggerDetails","data":{"type":"object","description":"Processing log trigger details.","properties":{"value":{"$ref":"#/components/schemas/ProcessingLogTriggerDetailsValue"}}}},"components/schemas/ProcessingLogTriggerDetailsValue":{"id":"components/schemas/ProcessingLogTriggerDetailsValue","kind":"json-schema","title":"ProcessingLogTriggerDetailsValue","data":{"type":"string","description":"Processing log trigger details value.","example":"12345"}},"components/schemas/NameParam":{"id":"components/schemas/NameParam","kind":"json-schema","title":"NameParam","data":{"type":"object","description":"Name of a business partner.","properties":{"value":{"$ref":"#/components/schemas/NameValue"}}}},"components/schemas/BusinessPartnerValidationResult":{"id":"components/schemas/BusinessPartnerValidationResult","kind":"json-schema","title":"BusinessPartnerValidationResult","data":{"type":"object","description":"Validation result for a single Business Partner.","properties":{"dataDefects":{"type":"array","description":"List of Data Defects.","items":{"$ref":"#/components/schemas/DataDefect"}},"qualificationResult":{"$ref":"#/components/schemas/QualificationResult"},"lookupResults":{"type":"array","description":"List of Lookup Results.","items":{"$ref":"#/components/schemas/LookupResult"}},"summary":{"$ref":"#/components/schemas/ValidationSummary"},"debugInfo":{"$ref":"#/components/schemas/DebugInfo"},"identifierResults":{"$ref":"#/components/schemas/IdentifierResults"},"businessPartner":{"$ref":"#/components/schemas/BusinessPartner3"},"rulesInError":{"$ref":"#/components/schemas/RulesInError"},"executedAt":{"type":"string","description":"ISO 8601 representation of the timestamp when the result data was created.","example":"2026-11-10T13:37:16Z"}}}},"components/schemas/BusinessPartnerValidationJob":{"id":"components/schemas/BusinessPartnerValidationJob","kind":"json-schema","title":"BusinessPartnerValidationJob","data":{"type":"object","description":"Represents a job for validating a Business Partner.","allOf":[{"$ref":"#/components/schemas/BusinessPartnerValidationJobResult"},{"type":"object","description":"Represents a job for validating a Business Partner.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"status":{"$ref":"#/components/schemas/JobStatus"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"finishedAt":{"$ref":"#/components/schemas/FinishedAt"},"user":{"$ref":"#/components/schemas/UserId"},"progress":{"$ref":"#/components/schemas/JobProgress"}}}]}},"components/schemas/JobProcessingLogTrigger":{"id":"components/schemas/JobProcessingLogTrigger","kind":"json-schema","title":"JobProcessingLogTrigger","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The processing log trigger type indicates how the validation item or job was triggered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Business partner has been created, and monitoring is activated for its data source."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Business partner has been updated, and monitoring is activated for its data source."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFERENCE_DATA_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Linked business partner has been updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFRESHED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Validity span mechanism has been triggered, or previous processing has failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INITIALIZED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Data monitor has been created or reactivated, and the business partner didn't have processing log results before."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFIGURATION_MODIFIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Configuration has been modified for the scope, where the business partner is considered."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MANUALLY_FORCED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Processing of all business partners has been forced by the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MONITORING_REENABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Data monitor has been enabled from disabled, and the business partner already had processing log results before."},"children":[]}]}]}]}],"example":"INITIALIZED"}},"components/schemas/BusinessPartnerValidationJobRequest":{"id":"components/schemas/BusinessPartnerValidationJobRequest","kind":"json-schema","title":"BusinessPartnerValidationJobRequest","data":{"type":"object","description":"Job request for validation of a single Business Partner.","allOf":[{"$ref":"#/components/schemas/ValidationJobRequest"},{"$ref":"#/components/schemas/BusinessPartnerValidationJobParams"}],"properties":{"criticalities":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criticalities of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CDL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rules that are active during the validation process."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CriticalityRequest"}}}}},"components/schemas/BusinessPartnerValidationJobResult":{"id":"components/schemas/BusinessPartnerValidationJobResult","kind":"json-schema","title":"BusinessPartnerValidationJobResult","data":{"type":"object","description":"Validation job result for a single Business Partner.","allOf":[{"$ref":"#/components/schemas/ValidationJobResult"},{"$ref":"#/components/schemas/BusinessPartnerValidationJobParams"}],"properties":{"criticalities":{"type":"array","description":"Criticalities of the CDL rules that are active during the validation process.","items":{"$ref":"#/components/schemas/Criticality"}}}}},"components/schemas/BusinessPartnerValidationJobParams":{"id":"components/schemas/BusinessPartnerValidationJobParams","kind":"json-schema","title":"BusinessPartnerValidationJobParams","data":{"type":"object","description":"Parameters for validation of a single Business Partner.","properties":{"ruleCategoriesOn":{"type":"array","description":"List of rule categories that are used to filter rules by their category. If any value is present, then only the rules of the given category will be promoted to execution.","items":{"$ref":"#/components/schemas/RuleCategory"}},"ignoredRules":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CDL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rules are ignored during the validation process."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/BusinessRuleUrl"}},"activatedRules":{"type":"array","description":"URLs of CDL rules that are active during the validation process.","items":{"$ref":"#/components/schemas/BusinessRuleUrl"}},"updatedFrom":{"type":"string","description":"Makes the job validate entries which were modified after the given date described in ISO-8601 format.","example":"2026-11-10T13:37:16Z"},"dataSourceIds":{"description":"If set, only the records that belong to the data sources identified by these IDs are processed. By default, all records of the storage (from all data sources) are processed (considering other filters).","type":"array","items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"}},"countryShortNames":{"description":"If set, only the records that belong to the countries identified by these short names are processed. By default, all records of the storage (from all countries) are processed (considering other filters).","type":"array","items":{"$ref":"#/components/schemas/CountryShortName"}},"configurationId":{"$ref":"#/components/schemas/ConfigurationId"}}}},"components/schemas/ValidationJobResult":{"id":"components/schemas/ValidationJobResult","kind":"json-schema","title":"ValidationJobResult","data":{"type":"object","description":"Result of a validation job.","allOf":[{"$ref":"#/components/schemas/ValidationJobParams"},{"type":"object","description":"Result of a validation job.","properties":{"profile":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile, which is used during validation. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUICK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This profile checks data quality of records in a quick way, i.e., data quality rules that have a negative impact on performance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This profile checks data quality using CDQ's standard configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUALIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Deprecated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTOMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Deprecated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EU_VAT_QUALIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This profile qualifies EU VATs using CDQ's default configuration of data quality rules for qualified checks of EU VATs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATA_SHARING_QUALITY_GATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Quality checks ensure that only valid data enters the CDQ Community Data Pool"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTIFIER_QUALITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This profile checks identifiers with a standard configuration of data quality rules. It does not comprise qualified checks of identifiers, e.g., name or address."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADDRESS_QUALITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This profile checks addresses with a standard configuration of data quality rules."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WORLDWIDE_IDENTIFIER_QUALIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This profile qualifies any supported business identifier (e.g., tax numbers) worldwide using CDQ's default configuration of data quality rules for qualified checks of a particular identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FEATURES_OFF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This profile turns off any qualification rules and is designed for custom rules selection."},"children":[]}]}]}]}],"example":"QUICK"},"featuresOn":{"$ref":"#/components/schemas/ValidationJobFeature"},"featuresOff":{"$ref":"#/components/schemas/ValidationJobFeature"},"ruleStatuses":{"type":"array","description":"Enable rules with provided statuses","items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of a validation rule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RELEASED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rule is released and will be executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DRAFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rule is in draft status and will not be executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HYPERCARE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rule is in hypercare and will be executed."},"children":[]}]}]}]}],"example":"RELEASED","default":"RELEASED"}},"validationSource":{"$ref":"#/components/schemas/ValidationSource"}}}]}},"components/schemas/ValidationJobParams":{"id":"components/schemas/ValidationJobParams","kind":"json-schema","title":"ValidationJobParams","data":{"type":"object","description":"Common parameters of a validation job.","properties":{"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"vatAtRequestor":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED, use organizational settings to configure."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requester’s VAT identifier is required to execute requests against external data sources."},"children":[]}]}]}],"example":"AT123456789"},"vatDeRequestor":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use organizational settings to configure."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requester’s VAT identifier is required to execute requests against external data sources."},"children":[]}]}]}],"example":"DE123456789"},"bzstPrint":{"type":"string","example":"true","description":"Request printed confirmation by German BZSt authority."},"dataSourcesOn":{"type":"array","description":"If data sources are disabled by a feature toggle, you can enable some of them by passing their prefixes here.","items":{"$ref":"#/components/schemas/DataSource"}},"dataSourcesOff":{"type":"array","description":"Rules with data sources passed here are not used in the validation process.","items":{"$ref":"#/components/schemas/DataSource"}}}}},"components/schemas/ValidationJobFeature":{"id":"components/schemas/ValidationJobFeature","kind":"json-schema","title":"ValidationJobFeature","data":{"type":"array","description":"List of features to be activated or deactivated.","items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features are used to activate or deactivate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADDRESS_CHECKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - CDQ data quality profiling services enable the validation of addresses with respect to different data quality criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANKING_DATA_CHECKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - CDQ data quality profiling services enable the validation of bank master data with respect to different data quality criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_PARTNER_CHECKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Validate concepts that basically establish a business partner (e.g., name and legal form)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENRICH_CATEGORIES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Enrich a CDL community standardized business partner category for a given entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENRICH_LEGAL_FORM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Identify and enrich the legal form of a company."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EU_VAT_QUALIFICATION_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Enforces the use of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AT.FON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data source to qualify EU VATs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EU_VAT_QUALIFICATION_DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Enforces the use of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BZST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data source for non-German business partners."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EU_VAT_QUALIFICATION_STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - For a given EU VAT, it is checked whether the name and address are really associated with this identifier (same information maintained in the VAT register as provided by the user)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTERNAL_SOURCES_OFF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Turns off external data sources."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTIFIER_CHECKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Validate business (VAT, tax, business register IDs) and location identifiers against different data quality rules categories."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTIFIER_QUALIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Turns on identifier qualification (standard), which enables the qualification of EU VAT identifiers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LAB_BETA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Deprecated feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LAB_USE_QUEUES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Perform uploading processing log with queue. Enable as default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUALIFICATION_SILENT_MODE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - If enabled, all exceptions occurring within the execution of business rules are ignored. If not enabled, then an execution error will result in creating a data defect. By default, part of the profile QUALIFICATION."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_BUSINESSPARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Shows the business partner that was used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_DATA_DEFECTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Shows found data defects - usually it is turned on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_DEBUG_INFO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Shows additional information about the validation process (number of applied rules, used categories, failed executions, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_DECISIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Deprecated feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_LOOKUP_RESULTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Displays results from the lookup endpoint (usually enriched data in comparison to the original business partner requested)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_QUALIFICATION_DECISIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Shows qualification decisions - used only in the qualification endpoint in API v3. In APIv1 and APIv2, it is used in the validation endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USE_SPARQL_VALIDATOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Deprecated feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FORCE_EXTERNAL_CALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Force external call."},"children":[]}]}]}]}],"example":"SHOW_LOOKUP_RESULTS"}}},"components/schemas/ValidationJobFeatureParam":{"id":"components/schemas/ValidationJobFeatureParam","kind":"json-schema","title":"ValidationJobFeatureParam","data":{"type":"array","description":"List of features to be activated or deactivated.","items":{"type":"string","description":"Features are used to activate or deactivate.","example":"SHOW_LOOKUP_RESULTS","enum":["ADDRESS_CHECKS","BANKING_DATA_CHECKS","BUSINESS_PARTNER_CHECKS","ENRICH_CATEGORIES","ENRICH_LEGAL_FORM","EU_VAT_QUALIFICATION_AT","EU_VAT_QUALIFICATION_DE","EU_VAT_QUALIFICATION_STANDARD","EXTERNAL_SOURCES_OFF","IDENTIFIER_CHECKS","IDENTIFIER_QUALIFICATION","LAB_BETA","LAB_USE_QUEUES","QUALIFICATION_SILENT_MODE","SHOW_BUSINESSPARTNER","SHOW_DATA_DEFECTS","SHOW_DEBUG_INFO","SHOW_DECISIONS","SHOW_LOOKUP_RESULTS","SHOW_QUALIFICATION_DECISIONS","USE_SPARQL_VALIDATOR","FORCE_EXTERNAL_CALL"],"x-enumDescriptions":{"ADDRESS_CHECKS":"CDQ data quality profiling services enable validation of addresses against various data quality criteria.","BANKING_DATA_CHECKS":"CDQ data quality profiling services enable validation of bank master data against various data quality criteria.","BUSINESS_PARTNER_CHECKS":"Validate concepts that basically establish a business partner (e.g., name and legal form).","ENRICH_CATEGORIES":"Enrich a CDL community standardized business partner category for a given entity.","ENRICH_LEGAL_FORM":"Identify and enrich the legal form of a company.","EU_VAT_QUALIFICATION_AT":"Enforces the use of AT.FON data source to qualify EU VATs.","EU_VAT_QUALIFICATION_DE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enforces the use of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BZST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data source for non-German business partners."},"children":[]}]}]}],"EU_VAT_QUALIFICATION_STANDARD":"For a given EU VAT, it is checked whether the name and address are actually associated with this identifier (the same information maintained in the VAT register as provided by the user).","EXTERNAL_SOURCES_OFF":"Turns off external data sources.","IDENTIFIER_CHECKS":"Validate business (VAT, tax, business register IDs) and location identifiers against different data quality rules categories.","IDENTIFIER_QUALIFICATION":"Turns on identifier qualification (standard), which enables the qualification of EU VAT identifiers.","LAB_BETA":"Deprecated feature.","LAB_USE_QUEUES":"Perform uploading processing log with the queue. Enable as default.","QUALIFICATION_SILENT_MODE":"If enabled, all exceptions that occur during the execution of business rules are ignored. If not enabled, then an execution error will result in creating a data defect. By default, part of the profile QUALIFICATION.","SHOW_BUSINESSPARTNER":"Shows the business partner that was used in the request.","SHOW_DATA_DEFECTS":"Shows found data defects - usually turned on.","SHOW_DEBUG_INFO":"Shows additional information about validation process (number of applied rules, used categories, failed executions etc.).","SHOW_DECISIONS":"Deprecated feature.","SHOW_LOOKUP_RESULTS":"Displays results from the lookup endpoint (usually enriched data in comparison to the original business partner requested).","SHOW_QUALIFICATION_DECISIONS":"Shows qualification decisions - used only in the qualification endpoint in API v3. In APIv1 and APIv2, it is used in the validation endpoint.","USE_SPARQL_VALIDATOR":"Deprecated feature.","FORCE_EXTERNAL_CALL":"Force external call."}}}},"components/schemas/ConfigurationId":{"id":"components/schemas/ConfigurationId","kind":"json-schema","title":"ConfigurationId","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration ID used to set up validation job. If provided, those parameters will be overridden:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleStatuses"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featuresOn"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featuresOff"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleCategoriesOn"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ignoredRules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activatedRules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criticalities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSourcesOn"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSourcesOff"},"children":[]}]}]}]}],"example":"6513d25b63cf07787018790a"}},"components/schemas/RecordValidationJob":{"id":"components/schemas/RecordValidationJob","kind":"json-schema","title":"RecordValidationJob","data":{"type":"object","description":"Job for validation of a single record.","allOf":[{"$ref":"#/components/schemas/RecordValidationJobResult"},{"type":"object","description":"Job for validation of a single record.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"status":{"$ref":"#/components/schemas/RecordValidationJobStatus"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"finishedAt":{"$ref":"#/components/schemas/FinishedAt"},"user":{"$ref":"#/components/schemas/JobUser"},"progress":{"$ref":"#/components/schemas/JobProgress"},"result":{"$ref":"#/components/schemas/RecordValidationResult"}}}]}},"components/schemas/RecordValidationJobResultPage":{"id":"components/schemas/RecordValidationJobResultPage","kind":"json-schema","title":"RecordValidationJobResultPage","data":{"type":"object","description":"Page of validation results.","properties":{"startAfter":{"$ref":"#/components/schemas/StartAfter"},"limit":{"$ref":"#/components/schemas/Limit"},"total":{"$ref":"#/components/schemas/PageTotal"},"values":{"type":"array","description":"List of validation results.","items":{"$ref":"#/components/schemas/RecordValidationResult"}},"nextStartAfter":{"$ref":"#/components/schemas/NextStartAfter"}}}},"components/schemas/RecordValidationJobRequest":{"id":"components/schemas/RecordValidationJobRequest","kind":"json-schema","title":"RecordValidationJobRequest","data":{"type":"object","description":"Parameters for validation of a single record.","required":["storageId","customKnowledgeGraph"],"properties":{"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"customKnowledgeGraph":{"type":"string","description":"Identifier for the custom knowledge graph that should be used for validation.","example":"kg_1_m_1"},"dataMapperDefinitionId":{"$ref":"#/components/schemas/DataMapperDefinitionId"},"profile":{"type":"string","description":"Profile which is used during validation. Default value is STANDARD.","example":"QUICK","enum":["QUICK","STANDARD"],"x-enumDescriptions":{"QUICK":"This profile checks data quality of records in a quick way, i.e. data quality rules that have a negative impact on performance (e.g. rules that use external webservices) are not executed. It does not provide a full check comprising all data quality rules, but allows for a rapid, initial assessment of data quality.","STANDARD":"This profile checks data quality using CDQ's standard configuration"}},"ruleStatuses":{"type":"array","description":"Filter for rule status.","items":{"$ref":"#/components/schemas/RuleStatus"}},"featuresOn":{"type":"array","description":"Activate features.","items":{"type":"string","description":"Feature to be activated.","example":"SHOW_LOOKUP_RESULTS","enum":["SHOW_LOOKUP_RESULTS","SHOW_DEBUG_INFO","LAB_BETA","ENRICH_LEGAL_FORM","ENRICH_CATEGORIES","USE_SPARQL_VALIDATOR","QUALIFICATION_SILENT_MODE","EXTERNAL_SOURCES_OFF","SHOW_BUSINESSPARTNER","MED_REG_VALIDATION"],"x-enumDescriptions":{"SHOW_LOOKUP_RESULTS":"Displays results from the lookup endpoint (usually enriched data in comparison to the original business partner requested).","SHOW_DEBUG_INFO":"Shows additional information about validation process (number of applied rules, used categories, failed executions etc.).","LAB_BETA":"Deprecated feature.","ENRICH_LEGAL_FORM":"Identify and enriches the legal form of a company.","ENRICH_CATEGORIES":"Enrich a CDL community standardized business partner category for a given entity.","USE_SPARQL_VALIDATOR":"Deprecated feature.","QUALIFICATION_SILENT_MODE":"If enabled all exceptions occurring within execution of business rules are ignored. If not enabled then execution error will result in creating data defect. By default, part of profile QUALIFICATION.","EXTERNAL_SOURCES_OFF":"Turns off external data sources.","SHOW_BUSINESSPARTNER":"Shows business partner that was used in the request.","MED_REG_VALIDATION":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If enabled it will execute validation only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MED_REG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" records. Applies only to Record Validation Job."},"children":[]}]}]}]}}},"ruleCategoriesOn":{"type":"array","description":"Categories use for selecting active business rules.","items":{"$ref":"#/components/schemas/RuleCategory"}},"ignoredRules":{"type":"array","description":"Urls of cdl rules ignored during validation process.","items":{"$ref":"#/components/schemas/BusinessRuleUrl"}},"activatedRules":{"type":"array","description":"Urls of cdl rules that are active during validation process.","items":{"$ref":"#/components/schemas/BusinessRuleUrl"}},"dataSourcesOn":{"type":"array","description":"If data sources are disabled by feature toggle you can enable some of them passing their prefixes here.","items":{"$ref":"#/components/schemas/DataSource"}},"dataSourcesOff":{"type":"array","description":"Rules with data sources passed here are not used in validation process.","items":{"$ref":"#/components/schemas/DataSource"}},"updatedFrom":{"type":"string","description":"Makes the job validate entries which were modified after given date described in ISO-8601 format.","example":"2026-11-10T13:37:16Z"},"dataSourceIds":{"type":"array","description":"If set, only the records that belong to the data sources identified by these IDs are processed. By default, all records of the storage (means from all data sources) are processed (considering other filters).","items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"}},"countryShortNames":{"type":"array","description":"If set, only the records that belong to the countries identified by these short names are processed. By default, all records of the storage (means from all countries) are processed (considering other filters).","items":{"$ref":"#/components/schemas/CountryShortName"}}}}},"components/schemas/RecordValidationJobResult":{"id":"components/schemas/RecordValidationJobResult","kind":"json-schema","title":"RecordValidationJobResult","data":{"type":"object","description":"Result of a validation job for a single record.","required":["storageId","customKnowledgeGraph"],"properties":{"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"customKnowledgeGraph":{"type":"string","description":"Identifier for the custom knowledge graph that should be used for validation.","example":"kg_1_m_1"},"dataMapperDefinitionId":{"$ref":"#/components/schemas/DataMapperDefinitionId"},"profile":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile, which is used during validation. The default value is STANDARD."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUICK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This profile checks data quality of records in a quick way, i.e., data quality rules that have a negative impact on performance (e.g., rules that use external web services) are not executed. It does not provide a full check comprising all data quality rules, but allows for a rapid initial assessment of data quality."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This profile checks data quality using CDQ's standard configuration."},"children":[]}]}]}]}],"example":"QUICK"},"ruleStatuses":{"type":"array","description":"Filter for rule status.","items":{"$ref":"#/components/schemas/RuleStatusResult"}},"featuresOn":{"type":"array","description":"Activate features.","items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature to be activated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_LOOKUP_RESULTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Displays results from the lookup endpoint (usually enriched data in comparison to the original business partner requested)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_DEBUG_INFO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Shows additional information about the validation process (number of applied rules, used categories, failed executions, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LAB_BETA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Deprecated feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENRICH_LEGAL_FORM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Identify and enrich the legal form of a company."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENRICH_CATEGORIES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Enrich a CDL community standardized business partner category for a given entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USE_SPARQL_VALIDATOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Deprecated feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUALIFICATION_SILENT_MODE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - If enabled, all exceptions occurring within the execution of business rules are ignored. If not enabled, then an execution error will result in creating a data defect. By default, part of the profile QUALIFICATION."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTERNAL_SOURCES_OFF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Turns off external data sources."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_BUSINESSPARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Shows the business partner that was used in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MED_REG_VALIDATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - If enabled, it will execute validation only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MED_REG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" records. Applies only to Record Validation Job."},"children":[]}]}]}]}],"example":"SHOW_LOOKUP_RESULTS"}},"ruleCategoriesOn":{"type":"array","description":"Categories are used for selecting active business rules.","items":{"$ref":"#/components/schemas/RuleCategory"}},"ignoredRules":{"type":"array","description":"URLs of CDL rules ignored during the validation process.","items":{"$ref":"#/components/schemas/BusinessRuleUrl"}},"activatedRules":{"type":"array","description":"URLs of CDL rules that are active during the validation process.","items":{"$ref":"#/components/schemas/BusinessRuleUrl"}},"dataSourcesOn":{"type":"array","description":"If data sources are disabled by feature toggle you can enable some of them passing their prefixes here.","items":{"$ref":"#/components/schemas/DataSource"}},"dataSourcesOff":{"type":"array","description":"Rules with data sources passed here are not used in validation process.","items":{"$ref":"#/components/schemas/DataSource"}},"updatedFrom":{"type":"string","description":"Makes the job validate entries which were modified after given date described in ISO-8601 format.","example":"2026-11-10T13:37:16Z"},"dataSourceIds":{"type":"array","description":"If set, only the records that belong to the data sources identified by these IDs are processed. By default, all records of the storage (means from all data sources) are processed (considering other filters).","items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"}},"countryShortNames":{"type":"array","description":"If set, only the records that belong to the countries identified by these short names are processed. By default, all records of the storage (from all countries) are processed (considering other filters).","items":{"$ref":"#/components/schemas/CountryShortName"}}}}},"components/schemas/RuleStatusResult":{"id":"components/schemas/RuleStatusResult","kind":"json-schema","title":"RuleStatusResult","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of a validation rule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RELEASED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rule was moved from status PLANNED automatically during daily testing or by manual maintenance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DRAFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rule was created as a draft, and it will not be executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HYPERCARE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rule was moved from status DEACTIVATED automatically during daily testing."},"children":[]}]}]}]}],"example":"RELEASED","default":"RELEASED"}},"components/schemas/JobDependencyResult":{"id":"components/schemas/JobDependencyResult","kind":"json-schema","title":"JobDependencyResult","data":{"type":"object","description":"Job dependency is used to schedule the next job when the current job is finished.","properties":{"id":{"type":"string","description":"UUID of the job that needs to be finished before the job can start execution.","example":"c2a0b3a0-8b0b-4b7a-8b0b-4b7a8b0b4b7a"},"strategy":{"$ref":"#/components/schemas/JobDependencyStrategy"}}}},"components/schemas/ValidationChunkWorkerResult":{"id":"components/schemas/ValidationChunkWorkerResult","kind":"json-schema","title":"ValidationChunkWorkerResult","data":{"type":"object","description":"Result of validation chunk.","allOf":[{"$ref":"#/components/schemas/BusinessPartnerChunkValidationWithQualificationResult"},{"type":"object","description":"Result of Business Partner Validation.","properties":{"numberOfProcessingLogTasksSent":{"$ref":"#/components/schemas/ValidationChunkWorkerResultNumberOfProcessingLogTasksSent"}}}]}},"components/schemas/ValidationChunkWorkerResultNumberOfProcessingLogTasksSent":{"id":"components/schemas/ValidationChunkWorkerResultNumberOfProcessingLogTasksSent","kind":"json-schema","title":"ValidationChunkWorkerResultNumberOfProcessingLogTasksSent","data":{"type":"integer","description":"Number of processing logs tasks sent.","example":"1"}},"components/schemas/CriticalityRequest":{"id":"components/schemas/CriticalityRequest","kind":"json-schema","title":"CriticalityRequest","data":{"type":"object","description":"Criticality level of a Business Rule.","properties":{"businessRuleUrl":{"$ref":"#/components/schemas/BusinessRuleUrl"},"violationLevel":{"$ref":"#/components/schemas/ViolationLevelParam"}}}},"components/schemas/Criticality":{"id":"components/schemas/Criticality","kind":"json-schema","title":"Criticality","data":{"type":"object","description":"Criticality level of a Business Rule.","properties":{"businessRuleUrl":{"$ref":"#/components/schemas/BusinessRuleUrl"},"violationLevel":{"$ref":"#/components/schemas/ViolationLevel"}}}},"components/schemas/DebugInfo":{"id":"components/schemas/DebugInfo","kind":"json-schema","title":"DebugInfo","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference implementation how to structure external service responses. Can be activated by a feature "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_DEBUG_INFO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"externalServiceResponses":{"type":"array","description":"List of external service responses.","items":{"$ref":"#/components/schemas/ExternalServiceResponse"}},"businessRulesExecutionSummary":{"$ref":"#/components/schemas/BusinessRulesExecutionSummary"}}}},"components/schemas/BusinessRulesExecutionSummary":{"id":"components/schemas/BusinessRulesExecutionSummary","kind":"json-schema","title":"BusinessRulesExecutionSummary","data":{"type":"object","description":"Summary of Business Rules execution.","properties":{"numberOfRules":{"type":"integer","description":"Number of rules executed.","example":"274"},"numberOfExecutions":{"type":"integer","description":"Number of rule executions.","example":"273"},"numberOfFails":{"type":"integer","description":"Number of failed rule executions.","example":"1"},"failures":{"type":"array","description":"List of failed rules.","items":{"$ref":"#/components/schemas/ValidationFailureLog"}},"warnings":{"type":"array","description":"List of data sources used in validation.","items":{"$ref":"#/components/schemas/ValidationWarningLog"}},"dataSourcesOn":{"type":"array","description":"List of data sources used in validation.","items":{"$ref":"#/components/schemas/DataSource"}},"dataSourcesOff":{"type":"array","description":"List of data sources not used in validation.","items":{"$ref":"#/components/schemas/DataSource"}},"activatedRules":{"type":"array","description":"List of activated rules.","items":{"$ref":"#/components/schemas/BusinessRuleUrl"}},"ignoredRules":{"type":"array","description":"List of ignored rules.","items":{"$ref":"#/components/schemas/BusinessRuleUrl"}},"ruleCategoriesOn":{"type":"array","description":"List of activated rule categories.","items":{"$ref":"#/components/schemas/RuleCategoryOn"}},"ruleStatuses":{"type":"array","description":"Filter for rule status.","items":{"$ref":"#/components/schemas/ValidationRuleStatus"}},"violationLevels":{"type":"array","description":"Filter for rule violation level (criticality).","items":{"$ref":"#/components/schemas/schemas-ViolationLevel"}}}}},"components/schemas/ValidationLogResultsReadFeatureEnum":{"id":"components/schemas/ValidationLogResultsReadFeatureEnum","kind":"json-schema","title":"ValidationLogResultsReadFeatureEnum","data":{"type":"string","description":"Validation log results read feature enum.","example":"FETCH_RESULT_DATA","enum":["FETCH_RESULT_DATA","NUMBER_OF_TOTAL"],"x-enumDescriptions":{"FETCH_RESULT_DATA":"Fetch result data.","NUMBER_OF_TOTAL":"Number of totals."}}},"components/schemas/ValidationResultField":{"id":"components/schemas/ValidationResultField","kind":"json-schema","title":"ValidationResultField","data":{"type":"string","description":"Field of validation result to include into result.","example":"dataDefects"}},"components/schemas/ValidationProcessingLogResultPage":{"id":"components/schemas/ValidationProcessingLogResultPage","kind":"json-schema","title":"ValidationProcessingLogResultPage","data":{"type":"object","description":"Page of validation log entries.","properties":{"startAfter":{"$ref":"#/components/schemas/StartAfter"},"nextStartAfter":{"$ref":"#/components/schemas/NextStartAfter"},"limit":{"$ref":"#/components/schemas/Limit"},"from":{"type":"string","description":"ISO 8601 representation of the timestamp when the result data was created.","example":"2026-11-10T13:37:16Z"},"to":{"type":"string","description":"ISO 8601 representation of the timestamp when the result data was created.","example":"2026-11-10T13:37:16Z"},"total":{"type":"integer","description":"Total number of validation log entries.","format":"int32","example":"20"},"values":{"type":"array","description":"List of validation log entries.","items":{"$ref":"#/components/schemas/ValidationProcessingLogResult"}}}}},"components/schemas/ValidationProcessingLogResult":{"id":"components/schemas/ValidationProcessingLogResult","kind":"json-schema","title":"ValidationProcessingLogResult","data":{"type":"object","description":"Validation log entry.","properties":{"dataSourceId":{"$ref":"#/components/schemas/StorageDataSourceId"},"businessPartnerId":{"$ref":"#/components/schemas/BusinessPartnerId"},"addressId":{"type":"string","description":"ID of the address in the storage or data mirror.","example":"123456789"},"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"addressExternalId":{"$ref":"#/components/schemas/AddressExternalId"},"status":{"type":"string","default":"OK","description":"Can be OK or FAILED - default is OK.","example":"OK"},"processingStatus":{"$ref":"#/components/schemas/ProcessingStatus"},"message":{"type":"string","description":"Additional explanations for status - especially for the FAILED case.","example":"Validation failed"},"validationResult":{"$ref":"#/components/schemas/BusinessPartnerValidationResult"},"executedAt":{"$ref":"#/components/schemas/CreatedAt"}}}},"components/schemas/ProcessingStatus":{"id":"components/schemas/ProcessingStatus","kind":"json-schema","title":"ProcessingStatus","data":{"type":"object","description":"Processing status.","properties":{"technicalKey":{"$ref":"#/components/schemas/ProcessingStatusTechnicalKey"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"}}}},"components/schemas/ValidationProcessingLogIdParam":{"id":"components/schemas/ValidationProcessingLogIdParam","kind":"json-schema","title":"ValidationProcessingLogIdParam","data":{"type":"string","description":"Validation processing log id to which data should be upserted by worker.","example":"VALIDATION_LOG","default":"VALIDATION_LOG","enum":["VALIDATION_LOG","VALIDATION_SHARING_LOG"],"x-enumDescriptions":{"VALIDATION_LOG":"Validation log id for validation results.","VALIDATION_SHARING_LOG":"Validation log id for sharing validation results."}}},"components/schemas/ValidationProcessingLogFeatureParam":{"id":"components/schemas/ValidationProcessingLogFeatureParam","kind":"json-schema","title":"ValidationProcessingLogFeatureParam","data":{"type":"string","description":"Validation processing log feature to which data should be upserted by worker.","example":"LAB_USE_QUEUES","enum":["LAB_USE_QUEUES"]}},"components/schemas/BusinessPartnerTriggerTypeEnum":{"id":"components/schemas/BusinessPartnerTriggerTypeEnum","kind":"json-schema","title":"BusinessPartnerTriggerTypeEnum","data":{"type":"string","description":"Type of trigger.","example":"UPDATED","enum":["CREATED","UPDATED","REFRESHED","REFERENCE_DATA_CHANGED"],"x-enumDescriptions":{"CREATED":"Triggered when a new record is created.","UPDATED":"Triggered when an existing record is updated.","REFRESHED":"Triggered when an existing record is refreshed.","REFERENCE_DATA_CHANGED":"Triggered when reference data is changed."}}},"components/schemas/JobDependencyStrategy":{"id":"components/schemas/JobDependencyStrategy","kind":"json-schema","title":"JobDependencyStrategy","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Strategy of job dependency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCHEDULE_NEXT_WHEN_ENDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Schedule the next job when the current job is ended."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCHEDULE_NEXT_WHEN_FINISHED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Schedule the next job when the current job is finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCHEDULE_NEXT_WHEN_FINISHED_OR_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Schedule the next job when the current job is finished or failed."},"children":[]}]}]}]}],"default":"SCHEDULE_NEXT_WHEN_FINISHED","example":"SCHEDULE_NEXT_WHEN_FINISHED"}},"components/schemas/RecordValidationJobStatus":{"id":"components/schemas/RecordValidationJobStatus","kind":"json-schema","title":"RecordValidationJobStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the job."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ARCHIVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Job is archived and cannot be accessed anymore."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Job becomes in an unknown status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Job has been created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSISTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Job metadata has been persisted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCHEDULED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Job has been scheduled for execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Job is waiting to be scheduled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COULDNT_START"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Job couldn't start."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RUNNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Job is being executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINISHED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Job has finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Job has died due to unhandled exceptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Job has failed."},"children":[]}]}]}]}],"example":"FINISHED"}},"components/schemas/WorkspaceConfigurationResponsePage":{"id":"components/schemas/WorkspaceConfigurationResponsePage","kind":"json-schema","title":"WorkspaceConfigurationResponsePage","data":{"type":"object","description":"Response page of workspaces configurations.","properties":{"startAfter":{"$ref":"#/components/schemas/StartAfter"},"nextStartAfter":{"$ref":"#/components/schemas/NextStartAfter"},"total":{"$ref":"#/components/schemas/PageTotal"},"values":{"type":"array","description":"List of configurations.","items":{"$ref":"#/components/schemas/WorkspaceConfiguration"}}}}},"components/schemas/WorkspaceConfigurationResult":{"id":"components/schemas/WorkspaceConfigurationResult","kind":"json-schema","title":"WorkspaceConfigurationResult","data":{"type":"object","description":"Contains the configuration and metadata.","properties":{"id":{"type":"string","description":"Unique identifier of the business partner validation configuration version. Not to be confused with the configuration ID.","example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"},"name":{"type":"string","description":"The name of the configuration.","example":"Configuration Name"},"version":{"$ref":"#/components/schemas/ConfigurationVersionNumber"},"configuration":{"$ref":"#/components/schemas/BusinessPartnerValidationConfiguration"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"defaultConfiguration":{"$ref":"#/components/schemas/DefaultWorkspaceConfiguration"}}}},"components/schemas/QualificationConfigurationResult":{"id":"components/schemas/QualificationConfigurationResult","kind":"json-schema","title":"QualificationConfigurationResult","data":{"type":"object","description":"Contains the configuration and metadata.","properties":{"id":{"type":"string","description":"Unique identifier of the business partner validation configuration version. Not to be confused with the configuration ID.","example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"},"name":{"type":"string","description":"The name of the configuration.","example":"Configuration Name"},"version":{"$ref":"#/components/schemas/ConfigurationVersionNumber"},"configuration":{"$ref":"#/components/schemas/QualificationConfiguration"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"defaultConfiguration":{"$ref":"#/components/schemas/DefaultWorkspaceConfiguration"}}}},"components/schemas/WorkspaceConfigurationVersionResult":{"id":"components/schemas/WorkspaceConfigurationVersionResult","kind":"json-schema","title":"WorkspaceConfigurationVersionResult","data":{"type":"object","description":"Specific version of a business partner validation configuration.","properties":{"id":{"type":"string","description":"Unique identifier of the business partner validation configuration version. Not to be confused with the configuration ID.","example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"},"name":{"type":"string","description":"The name of the configuration","example":"Configuration Name"},"configurationId":{"$ref":"#/components/schemas/schemas-ConfigurationId"},"version":{"$ref":"#/components/schemas/ConfigurationVersionNumber"},"configuration":{"$ref":"#/components/schemas/BusinessPartnerValidationConfiguration"},"createdAt":{"type":"string","description":"Date and time when the first version of the configuration was created (ISO 8601-compliant).","example":"2026-11-10T13:37:16Z"},"modifiedAt":{"type":"string","description":"Date and time when this version of the configuration was created (ISO 8601-compliant).","example":"2026-11-10T13:37:16Z"},"createdBy":{"type":"string","description":"User who created the first version of the configuration.","example":"69129435489347624"},"modifiedBy":{"type":"string","description":"User who created this version of the configuration.","example":"76248934691294444"},"defaultConfiguration":{"$ref":"#/components/schemas/DefaultWorkspaceConfiguration"}}}},"components/schemas/QualificationConfigurationVersionResult":{"id":"components/schemas/QualificationConfigurationVersionResult","kind":"json-schema","title":"QualificationConfigurationVersionResult","data":{"type":"object","description":"Specific version of a business partner validation configuration.","properties":{"id":{"type":"string","description":"Unique identifier of the business partner validation configuration version. Not to be confused with the configuration ID.","example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"},"name":{"type":"string","description":"The name of the configuration","example":"Configuration Name"},"configurationId":{"$ref":"#/components/schemas/schemas-ConfigurationId"},"version":{"$ref":"#/components/schemas/ConfigurationVersionNumber"},"configuration":{"$ref":"#/components/schemas/QualificationConfiguration"},"createdAt":{"type":"string","description":"Date and time when the first version of the configuration was created (ISO 8601-compliant).","example":"2026-11-10T13:37:16Z"},"modifiedAt":{"type":"string","description":"Date and time when this version of the configuration was created (ISO 8601-compliant).","example":"2026-11-10T13:37:16Z"},"createdBy":{"type":"string","description":"User who created the first version of the configuration.","example":"69129435489347624"},"modifiedBy":{"type":"string","description":"User who created this version of the configuration.","example":"76248934691294444"},"defaultConfiguration":{"$ref":"#/components/schemas/DefaultWorkspaceConfiguration"}}}},"components/schemas/ConfigurationVersionNumber":{"id":"components/schemas/ConfigurationVersionNumber","kind":"json-schema","title":"ConfigurationVersionNumber","data":{"type":"integer","description":"Version number of the configuration.","example":1}},"components/schemas/DefaultWorkspaceConfiguration":{"id":"components/schemas/DefaultWorkspaceConfiguration","kind":"json-schema","title":"DefaultWorkspaceConfiguration","data":{"type":"boolean","description":"The default workspace configuration. Only one configuration of a given type can be the default configuration in a given workspace.","example":true}},"components/schemas/WorkspaceConfiguration":{"id":"components/schemas/WorkspaceConfiguration","kind":"json-schema","title":"WorkspaceConfiguration","data":{"type":"object","description":"Configures behavior for Data Validation API.","properties":{"name":{"$ref":"#/components/schemas/ConfigurationName"},"id":{"$ref":"#/components/schemas/schemas-ConfigurationId"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"}}}},"components/schemas/WorkspaceConfigurationCreate":{"id":"components/schemas/WorkspaceConfigurationCreate","kind":"json-schema","title":"WorkspaceConfigurationCreate","data":{"type":"object","description":"Configuration to be created in the workspace of the current user.","properties":{"workspaceId":{"$ref":"#/components/schemas/WorkspaceId"},"name":{"type":"string","description":"The name of the configuration.","example":"Custom configuration name"},"configuration":{"$ref":"#/components/schemas/BusinessPartnerValidationConfigurationRequest"},"defaultConfiguration":{"$ref":"#/components/schemas/DefaultWorkspaceConfiguration"}}}},"components/schemas/WorkspaceConfigurationCopiedFrom":{"id":"components/schemas/WorkspaceConfigurationCopiedFrom","kind":"json-schema","title":"WorkspaceConfigurationCopiedFrom","data":{"type":"object","description":"The configuration from which the new configuration is copied.","required":["configurationId","workspaceId"],"properties":{"configurationId":{"$ref":"#/components/schemas/schemas-ConfigurationId"},"workspaceId":{"$ref":"#/components/schemas/WorkspaceId"}}}},"components/schemas/WorkspaceConfigurationUpdate":{"id":"components/schemas/WorkspaceConfigurationUpdate","kind":"json-schema","title":"WorkspaceConfigurationUpdate","data":{"type":"object","description":"Configuration to be updated in the workspace of the current user.","properties":{"featuresOn":{"$ref":"#/components/schemas/WorkspaceConfigurationUpdateFeaturesOn"},"name":{"type":"string","description":"The name of the configuration.","example":"Custom configuration name"},"defaultConfiguration":{"$ref":"#/components/schemas/DefaultWorkspaceConfiguration"},"configuration":{"$ref":"#/components/schemas/BusinessPartnerValidationConfigurationRequest"}}}},"components/schemas/TransactionId":{"id":"components/schemas/TransactionId","kind":"json-schema","title":"TransactionId","data":{"type":"string","description":"ID of the transaction, pass it in subsequent requests to make them part of the transaction.","example":"8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"}},"components/schemas/TransactionFeaturesOn":{"id":"components/schemas/TransactionFeaturesOn","kind":"json-schema","title":"TransactionFeaturesOn","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features to be enabled. Do not use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATE_TRANSACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMMIT_TRANSACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the same time."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TransactionFeatureParam"}}},"components/schemas/TransactionFeatureParam":{"id":"components/schemas/TransactionFeatureParam","kind":"json-schema","title":"TransactionFeatureParam","data":{"type":"string","description":"Feature used to control transaction process.","example":"CREATE_TRANSACTION","enum":["CREATE_TRANSACTION","COMMIT_TRANSACTION"],"x-enumDescriptions":{"CREATE_TRANSACTION":"Creates a new transaction and makes the current request a part of it. By default, turned off.","COMMIT_TRANSACTION":"Commit transaction. By default, turned off."}}},"components/schemas/RelatedConfiguration":{"id":"components/schemas/RelatedConfiguration","kind":"json-schema","title":"RelatedConfiguration","data":{"type":"object","description":"Id of the related configuration.","properties":{"id":{"$ref":"#/components/schemas/RelatedConfigurationId"},"owner":{"$ref":"#/components/schemas/RelatedConfigurationOwner"}}}},"components/schemas/RelatedConfigurationId":{"id":"components/schemas/RelatedConfigurationId","kind":"json-schema","title":"RelatedConfigurationId","data":{"type":"string","description":"Id of the related configuration.","example":"a0200062daa56952a8640005"}},"components/schemas/RelatedConfigurationOwner":{"id":"components/schemas/RelatedConfigurationOwner","kind":"json-schema","title":"RelatedConfigurationOwner","data":{"type":"object","description":"Configuration which relates to the root configuration.","properties":{"service":{"$ref":"#/components/schemas/RelatedConfigurationOwnerService"},"path":{"$ref":"#/components/schemas/RelatedConfigurationOwnerPath"}}}},"components/schemas/RelatedConfigurationOwnerService":{"id":"components/schemas/RelatedConfigurationOwnerService","kind":"json-schema","title":"RelatedConfigurationOwnerService","data":{"type":"string","description":"Name of the service that is the owner of the configuration.","example":"reference-data-api"}},"components/schemas/RelatedConfigurationOwnerPath":{"id":"components/schemas/RelatedConfigurationOwnerPath","kind":"json-schema","title":"RelatedConfigurationOwnerPath","data":{"type":"string","description":"Endpoint used to read the related configuration.","example":"/public/configurations/businesspartnerlookup"}},"components/schemas/WorkspaceConfigurationUpdateFeaturesOn":{"id":"components/schemas/WorkspaceConfigurationUpdateFeaturesOn","kind":"json-schema","title":"WorkspaceConfigurationUpdateFeaturesOn","data":{"type":"array","description":"Features to be enabled.","items":{"$ref":"#/components/schemas/WorkspaceConfigurationUpdateFeatureParam"}}},"components/schemas/WorkspaceConfigurationUpdateFeatureParam":{"id":"components/schemas/WorkspaceConfigurationUpdateFeatureParam","kind":"json-schema","title":"WorkspaceConfigurationUpdateFeatureParam","data":{"type":"string","description":"Feature used during configuration update.","example":"REEVALUATION_ON_CHANGES","enum":["REEVALUATION_ON_CHANGES"],"x-enumDescriptions":{"REEVALUATION_ON_CHANGES":"Re-evaluates business partners based on changes in the configuration."}}},"components/schemas/AddressQualificationDetails":{"id":"components/schemas/AddressQualificationDetails","kind":"json-schema","title":"AddressQualificationDetails","data":{"type":"object","description":"Qualification result for address.","properties":{"localityQualification":{"$ref":"#/components/schemas/QualificationStatus"},"postCodeQualification":{"$ref":"#/components/schemas/QualificationStatus"},"thoroughfareNumberQualification":{"$ref":"#/components/schemas/QualificationStatus"},"thoroughfareQualification":{"$ref":"#/components/schemas/QualificationStatus"}}}},"components/schemas/QualificationStatus":{"id":"components/schemas/QualificationStatus","kind":"json-schema","title":"QualificationStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Qualification results - verifies if the provided element and identifier match."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Provided element and identifier do not match."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUALIFIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Provided element and identifier match."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_PROVIDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Element is not provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Unknown qualification status."},"children":[]}]}]}]}],"example":"QUALIFIED"}},"components/schemas/BusinessRule":{"id":"components/schemas/BusinessRule","kind":"json-schema","title":"BusinessRule","data":{"type":"object","description":"Set of information about the Business Rule.","properties":{"name":{"$ref":"#/components/schemas/BusinessRuleName"},"url":{"$ref":"#/components/schemas/BusinessRuleUrl"},"ruleStatus":{"type":"string","description":"Status of the business rule.","example":"RELEASED"}}}},"components/schemas/LookupResult":{"id":"components/schemas/LookupResult","kind":"json-schema","title":"LookupResult","data":{"type":"object","description":"Contains data that was received from external data source.","properties":{"businessPartner":{"$ref":"#/components/schemas/BusinessPartner"},"address":{"$ref":"#/components/schemas/Address"},"matchingScore":{"type":"number","description":"Matching score of the lookup result.","example":"0.9"},"dataSource":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"cdqId":{"type":"string","description":"CDQ ID of the business partner.","example":"VIES:DE119267630"}}}},"components/schemas/Identifier":{"id":"components/schemas/Identifier","kind":"json-schema","title":"Identifier","data":{"type":"object","description":"Identifies a Business Partner in a given context uniquely such as a VAT identification number.","properties":{"issuingBody":{"$ref":"#/components/schemas/IssuingBodyName"},"type":{"$ref":"#/components/schemas/IdentifierType"},"value":{"$ref":"#/components/schemas/schemas-IdentifierValue"}}}},"components/schemas/IdentifierType":{"id":"components/schemas/IdentifierType","kind":"json-schema","title":"IdentifierType","data":{"type":"object","description":"Type of the identifier.","properties":{"url":{"$ref":"#/components/schemas/IdentifierTypeUrl"},"name":{"$ref":"#/components/schemas/IdentifierTypeName"},"technicalKey":{"$ref":"#/components/schemas/schemas-IdentifierTypeTechnicalKey"}}}},"components/schemas/Locality":{"id":"components/schemas/Locality","kind":"json-schema","title":"Locality","data":{"type":"object","description":"A locality is a named densely populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses. Many localities exist in an administrative area. A locality can also have several levels of sub localities.","properties":{"shortName":{"$ref":"#/components/schemas/LocalityShortName"},"type":{"$ref":"#/components/schemas/LocalityTypeName"},"value":{"$ref":"#/components/schemas/LocalityValue"}}}},"components/schemas/Name":{"id":"components/schemas/Name","kind":"json-schema","title":"Name","data":{"type":"object","description":"The name of a Business Partner.","required":["type","value"],"properties":{"details":{"type":"string","description":"Details of the Name.","example":"CDQ AG"},"language":{"$ref":"#/components/schemas/LanguageName"},"shortName":{"$ref":"#/components/schemas/NameShortName"},"type":{"type":"string","description":"Type of the Name.","example":"BUSINESS_PARTNER_NAME_TYPE_LOCAL"},"value":{"$ref":"#/components/schemas/NameValue"}}}},"components/schemas/PostCode":{"id":"components/schemas/PostCode","kind":"json-schema","title":"PostCode","data":{"type":"object","description":"A country specific code for a certain address component or a combination of address components, e.g. locality.","properties":{"shortName":{"type":"string","description":"Short name of the Post Code.","example":"PLZ"},"type":{"$ref":"#/components/schemas/PostCodeTypeName"},"value":{"$ref":"#/components/schemas/PostCodeValue"}}}},"components/schemas/ApiError":{"id":"components/schemas/ApiError","kind":"json-schema","title":"ApiError","data":{"type":"object","description":"Detailed information about API errors.","properties":{"timestamp":{"$ref":"#/components/schemas/ApiErrorTimestamp"},"message":{"$ref":"#/components/schemas/ApiErrorMessage"},"error":{"$ref":"#/components/schemas/HttpError"},"path":{"$ref":"#/components/schemas/HttpPath"},"status":{"$ref":"#/components/schemas/HttpStatus"},"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of an error, usually in a format of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_service_errorType_errorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"REF_VIES_SERVICE_UNAVAILABLE_300"}}}},"components/schemas/Thoroughfare":{"id":"components/schemas/Thoroughfare","kind":"json-schema","title":"Thoroughfare","data":{"type":"object","description":"Details of the access route along which buildings, lots, or land are located, such as street, road, channel, crescent, avenue, etc. This also includes canals or banks on which houses or boat houses are located where people live.","properties":{"direction":{"$ref":"#/components/schemas/ThoroughfareDirection"},"number":{"$ref":"#/components/schemas/ThoroughfareNumber"},"shortName":{"$ref":"#/components/schemas/ThoroughfareShortName"},"type":{"$ref":"#/components/schemas/ThoroughfareTypeName"},"value":{"$ref":"#/components/schemas/ThoroughfareValue"}}}},"components/schemas/BusinessPartner":{"id":"components/schemas/BusinessPartner","kind":"json-schema","title":"BusinessPartner","data":{"type":"object","description":"Refers to an organizational entity engaged in various facets of another organization's business interactions. This collaborative connection often manifests as a customer, supplier, vendor, or service provider. In the CDQ (Corporate Data Quality) framework, the Business Partner assumes a pivotal role as a core managed entity. Each Business Partner is distinctly and globally identifiable through a unique CDQ ID. All pertinent information, including addresses, identifiers, and hierarchical data, is intricately associated with and linked to the specific Business Partner, ensuring comprehensive management and traceability within the system.","properties":{"id":{"$ref":"#/components/schemas/BusinessPartnerId"},"names":{"type":"array","description":"List of names of the Business Partner.","items":{"$ref":"#/components/schemas/Name"}},"legalForm":{"$ref":"#/components/schemas/LegalForm"},"identifiers":{"type":"array","description":"List of identifiers of the Business Partner.","items":{"$ref":"#/components/schemas/Identifier"}},"categories":{"type":"array","description":"List of categories of the Business Partner.","items":{"$ref":"#/components/schemas/BusinessPartnerCategory"}},"addresses":{"type":"array","description":"List of addresses of the Business Partner.","items":{"$ref":"#/components/schemas/Address"}},"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"record":{"type":"string","description":"Stringified JSON of an individual business partner record.","example":"{name: ..., legalForm: ..., ...}"},"status":{"$ref":"#/components/schemas/BusinessPartnerStatus"}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","description":"An address provides information about the physical location of a business partner. It can be specialized in a certain context(e.g. delivery address or invoice address).","properties":{"id":{"type":"string","description":"ID of the address.","example":"0001"},"externalId":{"$ref":"#/components/schemas/AddressExternalId"},"country":{"$ref":"#/components/schemas/Country"},"administrativeAreas":{"type":"array","description":"List of Administrative Areas.","items":{"$ref":"#/components/schemas/AdministrativeArea"}},"postCode":{"$ref":"#/components/schemas/PostCode"},"localities":{"type":"array","description":"List of Localities.","items":{"$ref":"#/components/schemas/Locality"}},"thoroughfares":{"type":"array","description":"List of Thoroughfares.","items":{"$ref":"#/components/schemas/Thoroughfare"}},"premises":{"type":"array","description":"List of Premises.","items":{"$ref":"#/components/schemas/Premise"}},"postalDeliveryPoint":{"$ref":"#/components/schemas/PostalDeliveryPoint"},"geographicCoordinates":{"$ref":"#/components/schemas/GeographicCoordinates"},"types":{"type":"array","description":"List of Address Types.","items":{"$ref":"#/components/schemas/AddressType"}}}}},"components/schemas/BusinessPartnerCategory":{"id":"components/schemas/BusinessPartnerCategory","kind":"json-schema","title":"BusinessPartnerCategory","data":{"type":"object","description":"A Business Partner category of a business partner groups similar business partners.","properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerCategoryName"},"url":{"$ref":"#/components/schemas/BusinessPartnerCategoryUrl"}}}},"components/schemas/BusinessPartnerStatus":{"id":"components/schemas/BusinessPartnerStatus","kind":"json-schema","title":"BusinessPartnerStatus","data":{"type":"object","description":"The status of a Business Partner is a statement about its current state. It can be used to indicate whether a Business Partner is active or inactive, or whether it is a legal entity or a natural person.","properties":{"officialDenotation":{"$ref":"#/components/schemas/BusinessPartnerStatusOfficialDenotation"},"validFrom":{"$ref":"#/components/schemas/BusinessPartnerStatusValidFrom"},"validUntil":{"$ref":"#/components/schemas/BusinessPartnerStatusValidUntil"},"type":{"$ref":"#/components/schemas/BusinessPartnerStatusType"}}}},"components/schemas/BusinessPartnerStatusType":{"id":"components/schemas/BusinessPartnerStatusType","kind":"json-schema","title":"BusinessPartnerStatusType","data":{"type":"object","description":"Type of the Business Partner Status.","properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerStatusTypeName"},"url":{"$ref":"#/components/schemas/BusinessPartnerStatusTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerStatusTypeTechnicalKey"}}}},"components/schemas/LegalForm":{"id":"components/schemas/LegalForm","kind":"json-schema","title":"LegalForm","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal Form of a Business Partner is the form it takes in the eyes of the law governing it. The legal form of a Business Partner is the general type it may legally use to identify itself according to the local, regional, national, or international law governing it. This is normally reflected in the ending abbreviation after the Business Partner's name (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Inc."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LLC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S.A."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"name":{"$ref":"#/components/schemas/LegalFormName"},"url":{"$ref":"#/components/schemas/LegalFormUrl"},"mainAbbreviation":{"$ref":"#/components/schemas/LegalFormMainAbbreviation"},"technicalKey":{"$ref":"#/components/schemas/LegalFormTechnicalKey"}}}},"components/schemas/GeographicCoordinates":{"id":"components/schemas/GeographicCoordinates","kind":"json-schema","title":"GeographicCoordinates","data":{"description":"Decimal geographic coordinates (WGS 84 - reference coordinate system).","type":"object","properties":{"latitude":{"$ref":"#/components/schemas/GeographicCoordinatesLatitude"},"longitude":{"$ref":"#/components/schemas/GeographicCoordinatesLongitude"}}}},"components/schemas/PremiseType":{"id":"components/schemas/PremiseType","kind":"json-schema","title":"PremiseType","data":{"type":"object","description":"Type of the Premise.","properties":{"name":{"$ref":"#/components/schemas/PremiseTypeName"},"url":{"$ref":"#/components/schemas/PremiseTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/PremiseTypeTechnicalKey"}}}},"components/schemas/Premise":{"id":"components/schemas/Premise","kind":"json-schema","title":"Premise","data":{"type":"object","description":"A premise is a tract of land including its buildings. A premise may have several sub-levels to precisely identify.","properties":{"value":{"$ref":"#/components/schemas/PremiseValue"},"shortName":{"$ref":"#/components/schemas/PremiseShortName"},"number":{"$ref":"#/components/schemas/PremiseNumber"},"type":{"$ref":"#/components/schemas/PremiseType"}}}},"components/schemas/AdministrativeArea":{"id":"components/schemas/AdministrativeArea","kind":"json-schema","title":"AdministrativeArea","data":{"type":"object","description":"A top-level geographical or political area division in a country.","properties":{"value":{"$ref":"#/components/schemas/AdministrativeAreaValue"},"shortName":{"$ref":"#/components/schemas/AdministrativeAreaShortName"},"type":{"$ref":"#/components/schemas/AdministrativeAreaType"}}}},"components/schemas/AdministrativeAreaType":{"id":"components/schemas/AdministrativeAreaType","kind":"json-schema","title":"AdministrativeAreaType","data":{"type":"object","description":"Type of the Administrative Area.","properties":{"name":{"$ref":"#/components/schemas/AdministrativeAreaTypeName"},"url":{"$ref":"#/components/schemas/AdministrativeAreaTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/AdministrativeAreaTypeTechnicalKey"}}}},"components/schemas/AddressType":{"id":"components/schemas/AddressType","kind":"json-schema","title":"AddressType","data":{"type":"object","description":"An address type characterizes an address. The type of an address is a structural statement and provides a truth that is applicable to any user (e.g. a legal address is a fact, or that an address is a PO BOX address), other than address functions that may differ from user to user. Address functions determine the particular business context in which an address is in use.","properties":{"name":{"$ref":"#/components/schemas/AddressTypeName"},"url":{"$ref":"#/components/schemas/AddressTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/AddressTypeTechnicalKey"}}}},"components/schemas/Country":{"id":"components/schemas/Country","kind":"json-schema","title":"Country","data":{"type":"object","description":"Country consisting of the country name and country code (ISO 3166-1 alpha-2).","properties":{"shortName":{"$ref":"#/components/schemas/CountryShortName"},"value":{"$ref":"#/components/schemas/CountryValue"}}}},"components/schemas/PostalDeliveryPoint":{"id":"components/schemas/PostalDeliveryPoint","kind":"json-schema","title":"PostalDeliveryPoint","data":{"type":"object","description":"A single mailbox or other place at which postal mail is delivered.","properties":{"type":{"$ref":"#/components/schemas/PostalDeliveryPointType"},"shortName":{"$ref":"#/components/schemas/PostalDeliveryPointShortName"},"number":{"$ref":"#/components/schemas/PostalDeliveryPointNumber"},"value":{"$ref":"#/components/schemas/PostalDeliveryPointValue"}}}},"components/schemas/PostalDeliveryPointType":{"id":"components/schemas/PostalDeliveryPointType","kind":"json-schema","title":"PostalDeliveryPointType","data":{"type":"object","description":"A single mailbox or other place at which postal mail is delivered.","properties":{"name":{"$ref":"#/components/schemas/PostalDeliveryPointTypeName"},"url":{"$ref":"#/components/schemas/PostalDeliveryPointTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/PostalDeliveryPointTypeTechnicalKey"}}}},"components/schemas/ExternalServiceResponse":{"id":"components/schemas/ExternalServiceResponse","kind":"json-schema","title":"ExternalServiceResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carries information from response of external data sources. In case of using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it will additionally contain information with requestId returned from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"status":{"type":"integer","description":"HTTP status code returned from external Data Source.","example":"200"},"message":{"type":"string","description":"Typically, contains an error message received from external data source, only if returned. Can show CDQ-related messages.","example":"There is no more quota left for this Data Source."},"path":{"type":"string","description":"When legacy qualification is done with BZST Data Source, then full request path is returned","example":"/data-validation/businesspartners/validate"},"details":{"type":"string","description":"Additional details about External Service.","example":"Detailed message"},"timestamp":{"type":"string","description":"The timestamp of execution the request to external Data Source.","example":"2026-11-10T13:37:16Z"},"additionalInformation":{"type":"array","description":"Any additional information received during the original request.","items":{"$ref":"#/components/schemas/AdditionalInformation"}}}}},"components/schemas/AdditionalInformation":{"id":"components/schemas/AdditionalInformation","kind":"json-schema","title":"AdditionalInformation","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains Data Source related information (headers, requestor, id, etc.). Currently only supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Data Source."},"children":[]}]}]}],"properties":{"key":{"type":"string","description":"Property name.","example":"requestId"},"value":{"type":"string","description":"Value of given property.","example":"WAPIAAAAYse8yTdE"}}}},"components/schemas/ValidationSource":{"id":"components/schemas/ValidationSource","kind":"json-schema","title":"ValidationSource","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source is information obtained from the Business Rule, indicating which knowledge graph the Business Rule that detected the data defect belongs to."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Business Partner validation, the source is usually the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CDL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" knowledge graph because it contains business rules specific for Business Partner validation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In a Record validation process, two options may be present (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CDL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This depends on whether a data mapping definition was defined and whether business partner validation was executed in the context of record validation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CDL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Allows verifying the validity of a VAT number based on Corporate Data League rules."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BZST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Allows verifying the validity of a German VAT number with confirmation from the German BZST authority."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Allows verifying the validity of a VAT number issued by any European Member State. For all countries except Germany, registration data (name and address for which VAT is registered) can also be obtained. For Spain registration, data can only be confirmed, not received, by providing only the VAT number."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Allows verifying the validity of a VAT number issued by any European Member State."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Allows verifying the validity of a VAT number based on custom rules set by the customer in the CDQ's wiki."},"children":[]}]}]}]}],"example":"VIES"}},"components/schemas/ValidationSourceParam":{"id":"components/schemas/ValidationSourceParam","kind":"json-schema","title":"ValidationSourceParam","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source is information obtained from the Business Rule, indicating which knowledge graph the Business Rule that detected the data defect belongs to."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Business Partner validation, the source is usually the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CDL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" knowledge graph because it contains business rules specific for Business Partner validation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In a Record validation process, two options may be present (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CDL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This depends on whether a data mapping definition was defined and whether business partner validation was executed in the context of record validation."},"children":[]}]}]}],"type":"string","enum":["VIES","AT","BZST","CDL","CUSTOM"],"x-enumDescriptions":{"CDL":"Allows verifying the validity of a VAT number based on Corporate Data League rules.","BZST":"Allows verifying the validity of a German VAT number with confirmation from the German BZST authority.","VIES":"Allows verifying the validity of a VAT number issued by any European Member State. For all countries except Germany, registration data (name and address for which VAT is registered) can also be obtained. For Spain registration, data can only be confirmed, not received, by providing only the VAT number.","AT":"Allows verifying the validity of a VAT number issued by any European Member State.","CUSTOM":"Allows verifying the validity of a VAT number based on custom rules set by the customer in the CDQ's wiki."},"example":"VIES"}},"components/schemas/KeyValue":{"id":"components/schemas/KeyValue","kind":"json-schema","title":"KeyValue","data":{"type":"object","description":"Key value pair.","properties":{"key":{"type":"string","description":"Key of the source data.","example":"addrz1"},"value":{"type":"string","description":"Value of the source data.","example":"CH-9000"}}}},"components/schemas/QualificationResult":{"id":"components/schemas/QualificationResult","kind":"json-schema","title":"QualificationResult","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QualificationResult is created when validation process takes into consideration "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/Public:Rule_category/Qualification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rules of category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the feature "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_QUALIFICATION_DECISIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled. Enabling qualification can be done by the profile related to the qualification. QualificationResult contains information about qualification decisions, the data that have been qualified and overall qualification decisions."},"children":[]}]}]}],"properties":{"sourceData":{"type":"array","description":"List of source data used for qualification.","items":{"$ref":"#/components/schemas/KeyValue"}},"formattedSourceData":{"$ref":"#/components/schemas/FormattedSourcedata"},"validatorStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shows if validator source has been "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OFFLINE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONLINE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" during request."},"children":[]}]}]}],"example":"ONLINE"},"validatorMessage":{"type":"string","description":"Additional message to describe validatorStatus.","example":"VAT ID is valid."},"qualifiedBy":{"$ref":"#/components/schemas/ValidationSource"},"qualifiedAt":{"type":"string","description":"Date and time of qualification.","example":"2026-11-10T13:37:16Z"},"addressQualification":{"$ref":"#/components/schemas/QualificationStatus"},"addressQualificationDetails":{"$ref":"#/components/schemas/AddressQualificationDetails"},"identifierValidity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validity of identifier (syntax, format, and not inactive)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Identifier provided by user is an existing identifier and matches the input data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Qualification decision that means the identifier is not a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" business partner or the business partner is inactive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Error occurred in execution of qualification, the validation engine is not able to tell if the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"VALID"},"businessPartnerNameQualification":{"$ref":"#/components/schemas/QualificationStatus"},"overallQualification":{"$ref":"#/components/schemas/QualificationStatus"}}}},"components/schemas/FormattedSourcedata":{"id":"components/schemas/FormattedSourcedata","kind":"json-schema","title":"FormattedSourcedata","data":{"type":"object","description":"Contains data that was received from external source (VIES, AT.FON, BZST) in a unified format.","properties":{"code":{"type":"string","description":"Code of Business Partner that was received from external data source.","example":"ATU12345678"},"message":{"type":"string","description":"Additional message to describe code.","example":"Message to be filled in."},"businessPartnerName":{"type":"string","description":"Name of Business Partner that was received from external data source.","example":"Muster AG"},"postCodeValue":{"type":"string","description":"Post Code of Business Partner that was received from external data source.","example":"9000"},"thoroughfareValue":{"type":"string","description":"Thoroughfare of Business Partner that was received from external data source.","example":"Hauptstrasse"},"localityValue":{"type":"string","description":"Locality of Business Partner that was received from external data source.","example":"München"}}}},"components/schemas/ValidationWarningLog":{"id":"components/schemas/ValidationWarningLog","kind":"json-schema","title":"ValidationWarningLog","data":{"type":"object","description":"Contains information about warnings regarding the rules.","properties":{"message":{"type":"string","description":"Descriptive message, usually a warning.","example":"Message to be filled in."}}}},"components/schemas/ValidationFailureLog":{"id":"components/schemas/ValidationFailureLog","kind":"json-schema","title":"ValidationFailureLog","data":{"type":"object","description":"Contains information whenever the rule cannot be executed e.g. SPARQL parsing errors.","properties":{"externalId":{"deprecated":true,"type":"string","description":"External ID of the Business Partner or Record being validated.","example":"955775"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descriptive message, usually an error, with the reason why execution of the rule didn’t succeed."},"children":[]}]}]}],"example":"Message to be filled in."},"businessRule":{"$ref":"#/components/schemas/BusinessRule"}}}},"components/schemas/JobDependency":{"id":"components/schemas/JobDependency","kind":"json-schema","title":"JobDependency","data":{"type":"object","description":"Job dependency is used to schedule next job when current job is finished.","properties":{"id":{"type":"string","description":"UUID of job that needs to be finished before the job can start execution.","example":"c2a0b3a0-8b0b-4b7a-8b0b-4b7a8b0b4b7a"},"strategy":{"type":"string","description":"Strategy of job dependency.","default":"SCHEDULE_NEXT_WHEN_FINISHED","example":"SCHEDULE_NEXT_WHEN_FINISHED","enum":["SCHEDULE_NEXT_WHEN_ENDED","SCHEDULE_NEXT_WHEN_FINISHED","SCHEDULE_NEXT_WHEN_FINISHED_OR_FAILED"],"x-enumDescriptions":{"SCHEDULE_NEXT_WHEN_ENDED":"Schedule next job when current job is ended.","SCHEDULE_NEXT_WHEN_FINISHED":"Schedule next job when current job is finished.","SCHEDULE_NEXT_WHEN_FINISHED_OR_FAILED":"Schedule next job when current job is finished or failed."}}}}},"components/schemas/Label":{"id":"components/schemas/Label","kind":"json-schema","title":"Label","data":{"type":"object","description":"Label is a key-value pair that can be used to tag jobs.","properties":{"key":{"type":"string","description":"Property name.","example":"domain","maxLength":63},"value":{"type":"string","description":"Value of given property.","example":"data-validation","maxLength":63}}}},"components/schemas/AdministrativeAreaParam":{"id":"components/schemas/AdministrativeAreaParam","kind":"json-schema","title":"AdministrativeAreaParam","data":{"type":"object","description":"A top-level geographical or political area division in a country.","properties":{"value":{"$ref":"#/components/schemas/AdministrativeAreaValue"}}}},"components/schemas/DataSource":{"id":"components/schemas/DataSource","kind":"json-schema","title":"DataSource","data":{"type":"object","description":"A sub-container of Data Storage/Data Mirror. Few data sources can have different data, mappings, and data monitors within the same data mirror.","properties":{"prefix":{"$ref":"#/components/schemas/DataSourcePrefix"}}}},"components/schemas/PostalDeliveryPointParam":{"id":"components/schemas/PostalDeliveryPointParam","kind":"json-schema","title":"PostalDeliveryPointParam","data":{"type":"object","description":"A single mailbox or other place at which postal mail is delivered.","properties":{"value":{"$ref":"#/components/schemas/PostalDeliveryPointValue"},"type":{"type":"object","description":"A single mailbox or other place at which postal mail is delivered.","properties":{"technicalKey":{"type":"string","description":"Technical key of the Postal Delivery Point.","example":"POST_OFFICE_BOX","enum":["POST_OFFICE_BOX"],"x-enumDescriptions":{"POST_OFFICE_BOX":"A uniquely addressable lockable box located on the premises of a post office station."}}}}}}},"components/schemas/DataMapperDefinitionId":{"id":"components/schemas/DataMapperDefinitionId","kind":"json-schema","title":"DataMapperDefinitionId","data":{"type":"string","description":"Mapping ID that should be used for the mapping. Overrules a mapping of the knowledge graph (if exists). To run validation against CDL Rules data mapping definition by given ID must exist and user executing validation needs to have permission to access it.","example":"8E2BDC316288T32011948311"}},"components/schemas/DataTransformationDefinitionId":{"id":"components/schemas/DataTransformationDefinitionId","kind":"json-schema","title":"DataTransformationDefinitionId","data":{"type":"string","description":"ID of related Data Transformation Definition.","example":"6440dba32b30176c5917b1b7"}},"components/schemas/Property":{"id":"components/schemas/Property","kind":"json-schema","title":"Property","data":{"type":"object","description":"Instantiated property of a data model.","properties":{"content":{"$ref":"#/components/schemas/PropertyContent"},"contentSelector":{"$ref":"#/components/schemas/PropertyContentSelector"},"name":{"$ref":"#/components/schemas/PropertyName"},"url":{"$ref":"#/components/schemas/PropertyUrl"},"rootConcept":{"$ref":"#/components/schemas/Concept"},"parentConcept":{"$ref":"#/components/schemas/Concept"}}}},"components/schemas/Concept":{"id":"components/schemas/Concept","kind":"json-schema","title":"Concept","data":{"type":"object","description":"The Concept is a part of the CDQ data model.","properties":{"id":{"type":"string","description":"ID which uniquely identifies the content in the (nested) object.","example":"EU_VAT_ID_DE"},"idSelector":{"type":"string","description":"JSON path which points to the id.","example":"businessPartner.identifiers[type.technicalKey=EU_VAT_ID_DE].technicalKey"},"name":{"$ref":"#/components/schemas/ConceptName"},"url":{"$ref":"#/components/schemas/ConceptUrl"}}}},"components/schemas/ValidationSummary":{"id":"components/schemas/ValidationSummary","kind":"json-schema","title":"ValidationSummary","data":{"type":"object","description":"Summary of the validation result.","properties":{"validationLevel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the highest violationLevel available from the available data defects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It can take multiple data defect violation levels and calculate the validationLevel based on those."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The priority is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means there was a failure in rule execution and validation engine was not able to give the decision based on existing results. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set only when no rules failed and no data defects are present."},"children":[]}]}]}],"example":"ERROR"},"dataQualityRecordStatus":{"$ref":"#/components/schemas/DataQualityRecordStatus"},"action":{"type":"string","description":"Consolidated action over all decisions","example":"FULL_CHECK"},"statistics":{"$ref":"#/components/schemas/Statistics"}}}},"components/schemas/DataQualityRecordStatus":{"id":"components/schemas/DataQualityRecordStatus","kind":"json-schema","title":"DataQualityRecordStatus","data":{"type":"object","description":"Information about the quality of the record, containing more descriptive content as message, technicalKey and description.","properties":{"name":{"type":"string","description":"Name of the data quality record status.","example":"No issues found"},"description":{"type":"string","description":"Description of the data quality record status.","example":"All rules have been executed, and we have found no data quality issues."},"technicalKey":{"type":"string","description":"Overall data quality status for validation checks against single business partner.\nThis status is calculated based on validationLevel and rulesInError.\n","example":"NO_ISSUES_FOUND"}}}},"components/schemas/Statistics":{"id":"components/schemas/Statistics","kind":"json-schema","title":"Statistics","data":{"type":"object","description":"Statistics of the validation result.","properties":{"numberOfInfoDataDefects":{"type":"integer","description":"Number of data defects with severity INFO.","example":"10"},"numberOfErrorDataDefects":{"type":"integer","description":"Number of data defects with severity ERROR.","example":"10"},"numberOfWarningDataDefects":{"type":"integer","description":"Number of data defects with severity WARNING.","example":"10"}}}},"components/schemas/Decision":{"id":"components/schemas/Decision","kind":"json-schema","title":"Decision","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used in record validation for special type of business rules called automation rules. It’s an output from validation engine on what to do with the validated record."},"children":[]}]}]}],"properties":{"properties":{"type":"array","description":"Properties which have been involved in the decision-making process.","items":{"$ref":"#/components/schemas/Property"}},"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes what action, if needed, to take with validated record. Possible values - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULL_CHECK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"FULL_CHECK"},"businessRule":{"$ref":"#/components/schemas/BusinessRule"}}}},"components/schemas/ValidationProfile":{"id":"components/schemas/ValidationProfile","kind":"json-schema","title":"ValidationProfile","data":{"type":"string","description":"Profile which is used during validation. Default value is STANDARD.","example":"QUICK","enum":["QUICK","STANDARD","QUALIFICATION","AUTOMATION","EU_VAT_QUALIFICATION","DATA_SHARING_QUALITY_GATE","IDENTIFIER_QUALITY","ADDRESS_QUALITY","WORLDWIDE_IDENTIFIER_QUALIFICATION","FEATURES_OFF"],"x-enumDescriptions":{"QUICK":"This profile checks data quality of records in a quick way, i.e. data quality rules that have a negative impact on performance.","STANDARD":"This profile checks data quality using CDQ's standard configuration.","QUALIFICATION":"Deprecated.","AUTOMATION":"Deprecated.","EU_VAT_QUALIFICATION":"This profile qualifies EU VATs using CDQ's default configuration of data quality rules for qualified checks of EU VATs","DATA_SHARING_QUALITY_GATE":"Quality checks ensure that only valid data enters the CDQ Community Data Pool","IDENTIFIER_QUALITY":"This profile checks identifiers with a standard configuration of data quality rules. It does not comprise qualified checks of identifiers regarding e.g. name or address.","ADDRESS_QUALITY":"This profile checks addresses with a standard configuration of data quality rules.","WORLDWIDE_IDENTIFIER_QUALIFICATION":"This profile qualifies any supported business identifier (e.g. tax numbers) worldwide using CDQ's default configuration of data quality rules for qualified checks of a particular identifier","FEATURES_OFF":"This profile turns off any qualification rules and is designed for custom rules selection."}}},"components/schemas/ValidationFeature":{"id":"components/schemas/ValidationFeature","kind":"json-schema","title":"ValidationFeature","data":{"type":"string","description":"Features to be used on during validation.","example":"SHOW_LOOKUP_RESULTS","enum":["ADDRESS_CHECKS","BANKING_DATA_CHECKS","BUSINESS_PARTNER_CHECKS","COUNTRY_CHECKS","ENRICH_CATEGORIES","ENRICH_DATA_MIRROR_CHANGES","ENRICH_LEGAL_FORM","EU_VAT_QUALIFICATION_AT","EU_VAT_QUALIFICATION_DE","EU_VAT_QUALIFICATION_STANDARD","EXTERNAL_SOURCES_OFF","FORCE_EXTERNAL_CALL","IDENTIFIER_CHECKS","IDENTIFIER_QUALIFICATION","LAB_BETA","QUALIFICATION_SILENT_MODE","SHOW_BUSINESSPARTNER","SHOW_DATA_DEFECTS","SHOW_DEBUG_INFO","SHOW_DECISIONS","SHOW_LOOKUP_RESULTS","SHOW_QUALIFICATION","SHOW_QUALIFICATION_DECISIONS","USE_SPARQL_VALIDATOR"],"x-enumDescriptions":{"ADDRESS_CHECKS":"CDQ data quality profiling services enable the validation of addresses with respect to different data quality criteria.","BANKING_DATA_CHECKS":"CDQ data quality profiling services enable the validation of bank master data with respect to different data quality criteria.","BUSINESS_PARTNER_CHECKS":"Validate concepts that basically establish a business partner (e.g. name and legal form).","COUNTRY_CHECKS":"Validate country information.","ENRICH_CATEGORIES":"Enrich a CDL community standardized business partner category for a given entity.","ENRICH_DATA_MIRROR_CHANGES":"Enriches the data with changes from the data mirror.","ENRICH_LEGAL_FORM":"Identify and enriches the legal form of a company.","EU_VAT_QUALIFICATION_AT":"Enforces to use AT.FON data source to qualify EU VATs.","EU_VAT_QUALIFICATION_DE":"Enforces to use BZST data source for non-German business partners.","EU_VAT_QUALIFICATION_STANDARD":"For a given EU VAT, it is checked whether the name and address are really associated with this identifier (same information maintained in the VAT register as provided by the user).","EXTERNAL_SOURCES_OFF":"Turns off external data sources.","FORCE_EXTERNAL_CALL":"Force external call.","IDENTIFIER_CHECKS":"Validate business (VAT, tax, business register IDs) and location identifiers against different data quality rules categories.","IDENTIFIER_QUALIFICATION":"Turns on identifier qualification (standard) which enables to qualify EU VAT identifiers.","LAB_BETA":"Deprecated feature.","QUALIFICATION_SILENT_MODE":"If enabled all exceptions occurring within execution of business rules are ignored. If not enabled then execution error will result in creating data defect. By default, part of profile QUALIFICATION.","SHOW_BUSINESSPARTNER":"Shows business partner that was used in the request.","SHOW_DATA_DEFECTS":"Shows found data defects - usually it is turned on.","SHOW_DEBUG_INFO":"Shows additional information about validation process (number of applied rules, used categories, failed executions etc.).","SHOW_DECISIONS":"Deprecated feature.","SHOW_LOOKUP_RESULTS":"Displays results from the lookup endpoint (usually enriched data in comparison to the original business partner requested).","SHOW_QUALIFICATION_DECISIONS":"Shows qualification decisions - used only in qualification endpoint in API v3. In APIv1 and APIv2 it is used in validation endpoint.","USE_SPARQL_VALIDATOR":"Deprecated feature."}}},"components/schemas/TestCustomRuleTestCase":{"id":"components/schemas/TestCustomRuleTestCase","kind":"json-schema","title":"TestCustomRuleTestCase","data":{"type":"object","description":"Test case for a custom rule.","properties":{"name":{"type":"string","description":"Name of the test case.","example":"Test case 1"},"data":{"type":"string","description":"JSON object with test case data. If data and jsonRecord are present, exception will be thrown.","example":"{\\\"name\\\":\\\"demo\\\"}"},"jsonRecord":{"type":"object","description":"Stringified test case data. If data and jsonRecord are present, exception will be thrown.","additionalProperties":true,"example":"{\\\"name\\\":\\\"demo\\\"}"}}}},"components/schemas/TestCustomRuleResult":{"id":"components/schemas/TestCustomRuleResult","kind":"json-schema","title":"TestCustomRuleResult","data":{"type":"object","description":"Result of testing a custom rule.","properties":{"testCaseName":{"type":"string","description":"Name of the test case.","example":"Test case 1"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the data defect was found, no data defect found or an error occurred during the execution."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_RESULT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESULT_FOUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"RESULT_FOUND"},"result":{"type":"string","description":"Contains data that was returned by the SPARQL Query.","example":"\"( ?identifierValue = \\\"ESB54751110\\\" ) ( ?content = \\\"XXX\\\" ) ( ?dataSource = \\\"AT.FON\\\" ) ( ?decision = \\\"INVALID\\\" ) ( ?identifierKey = \\\"EU_VAT_ID_ES\\\" ) ( ?parentConceptUrl = \\\"https://meta.cdq.com/Address/locality\\\\\" ) ( ?contentSelector = \\\"businessPartner.addresses[0].localities[type=CITY].value\\\" ) ( ?contentSelectorUrl = \\\"https://meta.cdq.com/Address/locality/value\\\\\" ) ( ?recordId = \\\"658ba67d-8003-45f0-ad46-536504fb88cf\\\" ) ( ?parentConceptId = \\\"CITY\\\" ) ( ?cdqId = \\\"AT.FON:ESB54751110\\\" ) ( ?errorCode = \\\"200\\\" ) ( ?parentConceptIdSelector = \\\"businessPartner.addresses[0].localities[type=CITY].type.technicalKey\\\" )\""},"errorMessage":{"type":"string","description":"Contains information in case of execution error, can describe lexical errors within Query or execution errors.","example":"There is a misspelled word s at line 43, column 37"},"resultCount":{"type":"integer","description":"Number of results.","example":"1"}}}},"components/schemas/RuleStatus":{"id":"components/schemas/RuleStatus","kind":"json-schema","title":"RuleStatus","data":{"type":"string","description":"The status of a validation rule.","example":"RELEASED","default":"RELEASED","enum":["RELEASED","DRAFT","HYPERCARE"],"x-enumDescriptions":{"RELEASED":"Rule was moved from status PLANNED automatically during daily testing or by manual maintenance.","DRAFT":"Rule was created as a draft and it will be not executed.","HYPERCARE":"Rule was moved from status DEACTIVATED automatically during daily testing."}}},"components/schemas/ValidationReportsRequestParams":{"id":"components/schemas/ValidationReportsRequestParams","kind":"json-schema","title":"ValidationReportsRequestParams","data":{"type":"object","description":"Parameters for Validation Reports.","properties":{}}},"components/schemas/JobTags":{"id":"components/schemas/JobTags","kind":"json-schema","title":"JobTags","data":{"type":"array","description":"List of tags.","maxItems":12,"items":{"$ref":"#/components/schemas/JobTag"}}},"components/schemas/JobTag":{"id":"components/schemas/JobTag","kind":"json-schema","title":"JobTag","data":{"type":"string","description":"Tags job with the string value.","example":"35f23c03-1c22-45fe-9484-3ffe769325de","maxLength":100}},"components/schemas/IdentifierResults":{"id":"components/schemas/IdentifierResults","kind":"json-schema","title":"IdentifierResults","data":{"type":"array","items":{"$ref":"#/components/schemas/IdentifierResult"}}},"components/schemas/IdentifierResult":{"id":"components/schemas/IdentifierResult","kind":"json-schema","title":"IdentifierResult","data":{"type":"object","description":"Result of a identifier check for a single Business Partner.","properties":{"property":{"$ref":"#/components/schemas/IdentifierProperty"},"reliabilityLevel":{"$ref":"#/components/schemas/ReliabilityLevel"},"qualificationDecisions":{"type":"array","description":"List of Qualification Decisions for a single identifier.","items":{"$ref":"#/components/schemas/QualificationDecision"}}}}},"components/schemas/IdentifierProperty":{"id":"components/schemas/IdentifierProperty","kind":"json-schema","title":"IdentifierProperty","data":{"type":"object","description":"Information about identifier that the identifier checks were executed against.","properties":{"value":{"type":"string","description":"Value of identifier that was processed to obtain identifier result.","example":"DE119267630"},"type":{"type":"string","description":"Type of identifier that was processed to obtain identifier result.","example":"EU_VAT_ID_DE"}}}},"components/schemas/ReliabilityLevel":{"id":"components/schemas/ReliabilityLevel","kind":"json-schema","title":"ReliabilityLevel","data":{"type":"object","description":"Summarized information made up from executed identifier checks and contains detailed identifier check information.","properties":{"name":{"$ref":"#/components/schemas/IdentifierName"},"url":{"$ref":"#/components/schemas/IdentifierUrl"},"value":{"$ref":"#/components/schemas/IdentifierValue"},"checks":{"$ref":"#/components/schemas/IdentifierChecks"}}}},"components/schemas/IdentifierChecks":{"id":"components/schemas/IdentifierChecks","kind":"json-schema","title":"IdentifierChecks","data":{"type":"array","description":"List of Identifier Checks.","items":{"$ref":"#/components/schemas/IdentifierCheck"}}},"components/schemas/IdentifierCheck":{"id":"components/schemas/IdentifierCheck","kind":"json-schema","title":"IdentifierCheck","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirms correctness of identifier, depending on executed check it will have different value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The highest value the more trusted the identifier is. There’s 4 categories of identifier checks:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/Identifier_format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value 2"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/Identifier_checkdigit"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value 3"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/Identifier_existence"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value 4"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/Identifier_qualification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value 5"},"children":[]}]}]}]}]}],"properties":{"name":{"$ref":"#/components/schemas/IdentifierName"},"url":{"$ref":"#/components/schemas/IdentifierUrl"},"value":{"$ref":"#/components/schemas/IdentifierValue"},"status":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifiers Check's status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Task has been processed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Task has failed."},"children":[]}]}]}]}],"example":"OK"},"validity":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replacement of status field to describe status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IdentifierCheck"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":"Name of the status.","example":"Valid"},"description":{"type":"string","description":"Description of the status.","example":"Identifier check was executed with success, confirms that identifier is meeting requirement for check to pass."},"technicalKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical key of the status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Identifier check was executed with success, confirming that the identifier is meeting the requirements for the check to pass."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Identifier check was executed with success, confirming that the identifier is not meeting the requirements for the check to pass."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Identifier check was executed with failure, confirmation of the status cannot be provided; this usually happens because of an external service failure."},"children":[]}]}]}]}],"example":"VALID"}}},"message":{"type":"string","description":"Provides an information in case of identifier check failure.","example":"External service error."}}}},"components/schemas/IdentifierName":{"id":"components/schemas/IdentifierName","kind":"json-schema","title":"IdentifierName","data":{"type":"string","description":"Name of executed identifier check.","example":"Identifier existence"}},"components/schemas/IdentifierUrl":{"id":"components/schemas/IdentifierUrl","kind":"json-schema","title":"IdentifierUrl","data":{"type":"string","description":"URL to the type of identifier check.","example":"N/A"}},"components/schemas/IdentifierValue":{"id":"components/schemas/IdentifierValue","kind":"json-schema","title":"IdentifierValue","data":{"type":"integer","description":"Number from 2 to 5, describes how trusted the identifier is.","example":"4"}},"components/schemas/QualificationDecision":{"id":"components/schemas/QualificationDecision","kind":"json-schema","title":"QualificationDecision","data":{"type":"object","description":"Decision made by qualification process for a single identifier. \nIt contains information about the decision, properties that were involved in the decision-making process and information about the identifier that was qualified.\n","properties":{"properties":{"type":"array","description":"Properties which have been involved in the decision-making process.","items":{"$ref":"#/components/schemas/Property"}},"businessRule":{"$ref":"#/components/schemas/BusinessRule"},"qualificationTarget":{"type":"string","example":"STREET","description":"Indicates the concept being qualified."},"decision":{"type":"string","description":"Decision as returned by the qualification process.","example":"VALID"},"cdqId":{"type":"string","description":"CDQ ID of a Business Partner record used in a given qualification process.","example":"VIES:DE119267630"},"dataSource":{"type":"string","description":"Data source used in a given qualification process.","example":"VIES"},"identifierValue":{"type":"string","description":"Value of the identifier used in a given qualification process.","example":"DE119267630"},"identifierType":{"type":"string","description":"Type of the identifier used in a given qualification process.","example":"EU_VAT_ID_DE"},"errorMessage":{"type":"string","description":"Optional error message in case qualification rule fails.","example":"Example."},"externalServiceResponse":{"$ref":"#/components/schemas/ExternalServiceResponse"}}}},"components/schemas/QualificationConfigurationRequest":{"id":"components/schemas/QualificationConfigurationRequest","kind":"json-schema","title":"QualificationConfigurationRequest","data":{"type":"object","description":"Configuration of the Tax Guard Identifier Qualification for a single Business Partner record.","allOf":[{"$ref":"#/components/schemas/QualificationConfigurationParams"}],"properties":{"criticalities":{"type":"array","description":"List of criticalities.","items":{"$ref":"#/components/schemas/ValidationCriticalityRequest"}}}}},"components/schemas/QualificationConfiguration":{"id":"components/schemas/QualificationConfiguration","kind":"json-schema","title":"QualificationConfiguration","data":{"type":"object","description":"Configuration of the Tax Guard Identifier Qualification for a single Business Partner record.","allOf":[{"$ref":"#/components/schemas/QualificationConfigurationParams"}],"properties":{"criticalities":{"type":"array","description":"List of criticalities.","items":{"$ref":"#/components/schemas/ValidationCriticality"}}}}},"components/schemas/QualificationConfigurationParams":{"id":"components/schemas/QualificationConfigurationParams","kind":"json-schema","title":"QualificationConfigurationParams","data":{"type":"object","description":"Parameters for the configuration of the Tax Guard Identifier Qualification for a single Business Partner record.","properties":{"qualificationProfile":{"$ref":"#/components/schemas/BusinessPartnerQualificationRequestProfile"},"ruleStatuses":{"type":"array","description":"Enable rules with provided statuses.","items":{"$ref":"#/components/schemas/ValidationRuleStatus"}},"featuresOn":{"type":"array","description":"List of features to be activated.","items":{"$ref":"#/components/schemas/schemas-ValidationFeature"}},"featuresOff":{"type":"array","description":"List of features to be deactivated.","items":{"$ref":"#/components/schemas/schemas-ValidationFeature"}},"ruleCategoriesOn":{"type":"array","description":"List of rule categories to be activated.","items":{"$ref":"#/components/schemas/ValidationRuleCategory"}},"ignoredRules":{"type":"array","description":"List of rules to be ignored.","items":{"$ref":"#/components/schemas/BusinessRuleUrl"}},"activatedRules":{"type":"array","description":"List of rules to be activated.","items":{"$ref":"#/components/schemas/BusinessRuleUrl"}},"dataSourcesOn":{"type":"array","description":"List of Data Sources to be activated.","items":{"$ref":"#/components/schemas/DataSource"}},"dataSourcesOff":{"type":"array","description":"List of Data Sources to be deactivated.","items":{"$ref":"#/components/schemas/DataSource"}},"violationMessages":{"$ref":"#/components/schemas/ViolationMessages"}}}},"components/schemas/BusinessPartnerValidationConfigurationRequest":{"id":"components/schemas/BusinessPartnerValidationConfigurationRequest","kind":"json-schema","title":"BusinessPartnerValidationConfigurationRequest","data":{"type":"object","description":"Configuration of the validation process for a single Business Partner record.","allOf":[{"$ref":"#/components/schemas/BusinessPartnerValidationConfigurationParams"}],"properties":{"criticalities":{"type":"array","description":"List of criticalities.","items":{"$ref":"#/components/schemas/ValidationCriticalityRequest"}}}}},"components/schemas/BusinessPartnerValidationConfiguration":{"id":"components/schemas/BusinessPartnerValidationConfiguration","kind":"json-schema","title":"BusinessPartnerValidationConfiguration","data":{"type":"object","description":"Configuration of the validation process for a single Business Partner record.","allOf":[{"$ref":"#/components/schemas/BusinessPartnerValidationConfigurationParams"}],"properties":{"criticalities":{"type":"array","description":"List of criticalities.","items":{"$ref":"#/components/schemas/ValidationCriticality"}}}}},"components/schemas/BusinessPartnerValidationConfigurationParams":{"id":"components/schemas/BusinessPartnerValidationConfigurationParams","kind":"json-schema","title":"BusinessPartnerValidationConfigurationParams","data":{"type":"object","description":"Parameters for the configuration of the validation process for a single Business Partner record.","properties":{"validationProfile":{"$ref":"#/components/schemas/schemas-ValidationProfile"},"ruleStatuses":{"type":"array","description":"Enable rules with provided statuses.","items":{"$ref":"#/components/schemas/ValidationRuleStatus"}},"featuresOn":{"type":"array","description":"List of features to be activated.","items":{"$ref":"#/components/schemas/schemas-ValidationFeature"}},"featuresOff":{"type":"array","description":"List of features to be deactivated.","items":{"$ref":"#/components/schemas/schemas-ValidationFeature"}},"ruleCategoriesOn":{"type":"array","description":"List of rule categories to be activated.","items":{"$ref":"#/components/schemas/ValidationRuleCategory"}},"ignoredRules":{"type":"array","description":"List of rules to be ignored.","items":{"$ref":"#/components/schemas/BusinessRuleUrl"}},"activatedRules":{"type":"array","description":"List of rules to be activated.","items":{"$ref":"#/components/schemas/BusinessRuleUrl"}},"dataSourcesOn":{"type":"array","description":"List of Data Sources to be activated.","items":{"$ref":"#/components/schemas/DataSource"}},"dataSourcesOff":{"type":"array","description":"List of Data Sources to be deactivated.","items":{"$ref":"#/components/schemas/DataSource"}},"violationMessages":{"$ref":"#/components/schemas/ViolationMessages"}}}},"components/schemas/DataValidationConfiguration":{"id":"components/schemas/DataValidationConfiguration","kind":"json-schema","title":"DataValidationConfiguration","data":{"type":"object","description":"Configuration of the data validation process for a single record.","properties":{"profile":{"$ref":"#/components/schemas/DataValidationProfile"},"dataTransformationDefinitionId":{"$ref":"#/components/schemas/DataTransformationDefinitionId"},"featuresOn":{"type":"array","description":"List of features to be activated.","items":{"$ref":"#/components/schemas/DataValidationFeature"}},"featuresOff":{"type":"array","description":"List of features to be deactivated.","items":{"$ref":"#/components/schemas/DataValidationFeature"}},"rulesOn":{"type":"array","description":"List of rules to be activated.","items":{"$ref":"#/components/schemas/DataValidationRuleTechnicalKey"}},"rulesOff":{"type":"array","description":"List of rules to be deactivated.","items":{"$ref":"#/components/schemas/DataValidationRuleTechnicalKey"}},"validationGraph":{"$ref":"#/components/schemas/ValidationGraph"},"ruleSelectionSettings":{"$ref":"#/components/schemas/RuleSelectionSettings"},"ruleCustomizationSettings":{"type":"array","description":"List of rule customizations.","items":{"$ref":"#/components/schemas/RuleCustomizationSetting"}}}}},"components/schemas/DataValidationConfigurationRequest":{"id":"components/schemas/DataValidationConfigurationRequest","kind":"json-schema","title":"DataValidationConfigurationRequest","data":{"type":"object","description":"Configuration of the data validation process for a single record.","properties":{"profile":{"$ref":"#/components/schemas/DataValidationProfileParam"},"dataTransformationDefinitionId":{"$ref":"#/components/schemas/DataTransformationDefinitionId"},"featuresOn":{"type":"array","description":"List of features to be activated.","items":{"$ref":"#/components/schemas/DataValidationFeatureParam"}},"featuresOff":{"type":"array","description":"List of features to be deactivated.","items":{"$ref":"#/components/schemas/DataValidationFeatureParam"}},"rulesOn":{"type":"array","description":"List of rules to be activated.","items":{"$ref":"#/components/schemas/DataValidationRuleTechnicalKey"}},"rulesOff":{"type":"array","description":"List of rules to be deactivated.","items":{"$ref":"#/components/schemas/DataValidationRuleTechnicalKey"}},"validationGraph":{"$ref":"#/components/schemas/ValidationGraph"},"ruleSelectionSettings":{"$ref":"#/components/schemas/RuleSelectionSettings"},"ruleCustomizationSettings":{"type":"array","description":"List of rule customizations.","items":{"$ref":"#/components/schemas/RuleCustomizationSetting"}}}}},"components/schemas/ValidationGraph":{"id":"components/schemas/ValidationGraph","kind":"json-schema","title":"ValidationGraph","data":{"type":"string","description":"Name of applied knowledge graph that is used for validation.","example":"CDQ_VALIDATION_GRAPH"}},"components/schemas/DataValidationRuleTechnicalKey":{"id":"components/schemas/DataValidationRuleTechnicalKey","kind":"json-schema","title":"DataValidationRuleTechnicalKey","data":{"type":"string","description":"Data Validation Rule represented by a technical key.","example":"A39S6C8RT353N5KV"}},"components/schemas/DataValidationProfile":{"id":"components/schemas/DataValidationProfile","kind":"json-schema","title":"DataValidationProfile","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Validation Profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASIC"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]}]}]}]}],"example":"BASIC"}},"components/schemas/DataValidationProfileParam":{"id":"components/schemas/DataValidationProfileParam","kind":"json-schema","title":"DataValidationProfileParam","data":{"type":"string","description":"Data Validation Profile.","example":"BASIC","enum":["BASIC","STANDARD","CUSTOM"],"x-enumDescriptions":{"BASIC":"This profile quickly checks the data quality of records, i.e., data quality rules that negatively impact performance.","STANDARD":"This profile checks data quality using CDQ's standard configuration.","CUSTOM":"This profile deactivates any qualification rules and is designed for selecting custom rules."}}},"components/schemas/DataValidationRuleStatus":{"id":"components/schemas/DataValidationRuleStatus","kind":"json-schema","title":"DataValidationRuleStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the validation rule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RELEASED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HYPERCARE"},"children":[]}]}]}]}],"example":"RELEASED"}},"components/schemas/DataValidationFeature":{"id":"components/schemas/DataValidationFeature","kind":"json-schema","title":"DataValidationFeature","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When enabled will trigger rules of related categories to execute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FORCE_EXTERNAL_CALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Forces calls on external services ignoring cache"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_DEBUG_INFO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Shows additional information about validation process (number of applied rules, used categories, failed executions etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_BUSINESS_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Includes Business Partner in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_LOOKUP_RESULTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Includes lookup results in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTERNAL_SOURCES_OFF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Turns off external data sources."},"children":[]}]}]}]}],"example":"SHOW_LOOKUP_RESULTS"}},"components/schemas/DataValidationFeatureParam":{"id":"components/schemas/DataValidationFeatureParam","kind":"json-schema","title":"DataValidationFeatureParam","data":{"type":"string","description":"Data Validation Feature.","example":"SHOW_LOOKUP_RESULTS","enum":["FORCE_EXTERNAL_CALL","SHOW_DEBUG_INFO","SHOW_BUSINESS_PARTNER","SHOW_LOOKUP_RESULTS","EXTERNAL_SOURCES_OFF"],"x-enumDescriptions":{"FORCE_EXTERNAL_CALL":"Forces calls on external services, ignoring cache.","SHOW_DEBUG_INFO":"Shows additional information about the validation process (number of applied rules, used categories, failed executions, etc.).","SHOW_BUSINESS_PARTNER":"Includes Business Partner in the response.","SHOW_LOOKUP_RESULTS":"Includes lookup results in the response.","EXTERNAL_SOURCES_OFF":"Turns off external data sources."}}},"components/schemas/DataValidationCriticality":{"id":"components/schemas/DataValidationCriticality","kind":"json-schema","title":"DataValidationCriticality","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents criticality level of a rule violation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates that the rule violation is of informational nature and does not necessarily require immediate attention."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates that the rule violation is of warning nature and may require attention."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates that the rule violation is of error nature and requires immediate attention."},"children":[]}]}]}]}],"example":"ERROR"}},"components/schemas/RuleSelectionSettings":{"id":"components/schemas/RuleSelectionSettings","kind":"json-schema","title":"RuleSelectionSettings","data":{"type":"object","description":"Settings for rule selection.","properties":{"statuses":{"type":"array","description":"Enable rules with provided statuses.","items":{"$ref":"#/components/schemas/DataValidationRuleStatus"}},"categoriesOn":{"type":"array","description":"List of rule categories to be activated.","items":{"$ref":"#/components/schemas/DataValidationRuleCategoryTechnicalKey"}},"categoriesOff":{"type":"array","description":"List of rule categories to be deactivated.","items":{"$ref":"#/components/schemas/DataValidationRuleCategoryTechnicalKey"}},"criticalitiesOn":{"type":"array","description":"List of criticality levels to be activated.","items":{"$ref":"#/components/schemas/DataValidationCriticality"}},"criticalitiesOff":{"type":"array","description":"List of criticality levels to be deactivated.","items":{"$ref":"#/components/schemas/DataValidationCriticality"}},"countriesOn":{"type":"array","description":"List of country short names to be activated for country-specific rules.","items":{"$ref":"#/components/schemas/DataValidationCountry"}},"countriesOff":{"type":"array","description":"List of country short names to be deactivated for country-specific rules.","items":{"$ref":"#/components/schemas/DataValidationCountry"}}}}},"components/schemas/RuleCustomizationSetting":{"id":"components/schemas/RuleCustomizationSetting","kind":"json-schema","title":"RuleCustomizationSetting","data":{"type":"object","description":"Settings for rule customization.","required":["businessRuleId"],"properties":{"businessRuleId":{"type":"string","description":"ID of the business rule to be customized.","example":"VYMX45QXCRHJC6YR"},"violationLevel":{"$ref":"#/components/schemas/DataValidationCriticality"},"violationMessage":{"type":"string","description":"Violation message that is returned with detected data defect.","example":"Business Partner identifier is mandatory."}}}},"components/schemas/DataValidationRuleCategoryTechnicalKey":{"id":"components/schemas/DataValidationRuleCategoryTechnicalKey","kind":"json-schema","title":"DataValidationRuleCategoryTechnicalKey","data":{"type":"string","description":"Category code of rules represented by a technical key.","example":"NAME_MISSING"}},"components/schemas/DataValidationCountry":{"id":"components/schemas/DataValidationCountry","kind":"json-schema","title":"DataValidationCountry","data":{"type":"object","description":"Country consisting of the country short name.","properties":{"shortName":{"$ref":"#/components/schemas/CountryShortName"}}}},"components/schemas/ValidationRuleCategory":{"id":"components/schemas/ValidationRuleCategory","kind":"json-schema","title":"ValidationRuleCategory","data":{"type":"object","description":"Category of rules - usually goal oriented, like Identifier missing, Dummy Postal Code or Country Invalid.","properties":{"url":{"$ref":"#/components/schemas/ValidationRuleCategoryUrl"}}}},"components/schemas/ValidationCriticalityRequest":{"id":"components/schemas/ValidationCriticalityRequest","kind":"json-schema","title":"ValidationCriticalityRequest","data":{"type":"object","description":"Represents violation level.","properties":{"businessRuleUrl":{"$ref":"#/components/schemas/BusinessRuleUrl"},"violationLevel":{"$ref":"#/components/schemas/ViolationLevelParam"}}}},"components/schemas/ValidationCriticality":{"id":"components/schemas/ValidationCriticality","kind":"json-schema","title":"ValidationCriticality","data":{"type":"object","description":"Represents violation level.","properties":{"businessRuleUrl":{"$ref":"#/components/schemas/BusinessRuleUrl"},"violationLevel":{"$ref":"#/components/schemas/ViolationLevel"}}}},"components/schemas/ViolationMessages":{"id":"components/schemas/ViolationMessages","kind":"json-schema","title":"ViolationMessages","data":{"type":"array","description":"List of violation messages.","items":{"$ref":"#/components/schemas/ViolationMessage"}}},"components/schemas/ViolationMessage":{"id":"components/schemas/ViolationMessage","kind":"json-schema","title":"ViolationMessage","data":{"type":"object","description":"Represents the information what was the problem (it shows only when a data defect was found).","properties":{"businessRuleUrl":{"$ref":"#/components/schemas/BusinessRuleUrl"},"violationMessage":{"type":"string","description":"Violation message that is returned with detected data defect.","example":"Business Partner identifier is mandatory."}}}},"components/schemas/ViolationLevel":{"id":"components/schemas/ViolationLevel","kind":"json-schema","title":"ViolationLevel","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the criticality of the applied rule. If a data defect is found, then the user will get"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" level. Otherwise, it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_DEFECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_DEFECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Validation has found no defect. This is the default value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Warning."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Error."},"children":[]}]}]}]}],"example":"INFO"}},"components/schemas/ViolationLevelParam":{"id":"components/schemas/ViolationLevelParam","kind":"json-schema","title":"ViolationLevelParam","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the criticality of the applied rule. If a data defect is found, then the user will get"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" level. Otherwise, it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_DEFECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"INFO","enum":["NO_DEFECT","INFO","WARNING","ERROR"],"x-enumDescriptions":{"NO_DEFECT":"Validation has found no defect. This is the default value.","INFO":"Information.","WARNING":"Warning.","ERROR":"Error."}}},"components/schemas/RulesInError":{"id":"components/schemas/RulesInError","kind":"json-schema","title":"RulesInError","data":{"type":"array","description":"List of rules executed with error.","items":{"$ref":"#/components/schemas/RuleExecutionResult"}}},"components/schemas/RuleExecutionResult":{"id":"components/schemas/RuleExecutionResult","kind":"json-schema","title":"RuleExecutionResult","data":{"type":"object","description":"Represents Data Quality Rules that executed with failure ex. external service was not responding.","properties":{"businessRule":{"$ref":"#/components/schemas/BusinessRule"},"executionStatus":{"$ref":"#/components/schemas/BusinessRuleExecutionStatus"},"error":{"$ref":"#/components/schemas/ApiError"},"ruleResult":{"$ref":"#/components/schemas/BusinessRuleResult"},"violationLevel":{"$ref":"#/components/schemas/ViolationLevel"},"validationSource":{"$ref":"#/components/schemas/ValidationSource"}}}},"components/schemas/BusinessRuleExecutionStatus":{"id":"components/schemas/BusinessRuleExecutionStatus","kind":"json-schema","title":"BusinessRuleExecutionStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about the execution process of the rule. For rules executed correctly "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", whenever rule execution is failing by external data sources the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"500"}},"components/schemas/ApiErrorWithStatus":{"id":"components/schemas/ApiErrorWithStatus","kind":"json-schema","title":"ApiErrorWithStatus","data":{"type":"object","description":"Detailed information about API errors.","properties":{"status":{"$ref":"#/components/schemas/Status"}}}},"components/schemas/Status":{"id":"components/schemas/Status","kind":"json-schema","title":"Status","data":{"type":"object","description":"Details about status or error of a service","required":["code","technicalKey","details"],"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"technicalKey":{"$ref":"#/components/schemas/HttpStatusTechnicalKey"},"details":{"type":"array","items":{"$ref":"#/components/schemas/StatusDetails"}},"path":{"$ref":"#/components/schemas/HttpPath"},"timestamp":{"$ref":"#/components/schemas/StatusTimestamp"}}}},"components/schemas/DataValidationJobId":{"id":"components/schemas/DataValidationJobId","kind":"json-schema","title":"DataValidationJobId","data":{"type":"string","description":"Data Validation Job ID.","example":"ef450653-a3bc-4476-83d3-d67397d475a0"}},"components/schemas/BusinessPartnerStorageId":{"id":"components/schemas/BusinessPartnerStorageId","kind":"json-schema","title":"BusinessPartnerStorageId","data":{"type":"string","description":"Unique identifier of the Storage.","example":"72d6900fce6b326088f5d9d91049e3e6"}},"components/schemas/BusinessRuleUrl":{"id":"components/schemas/BusinessRuleUrl","kind":"json-schema","title":"BusinessRuleUrl","data":{"type":"string","description":"Represents Data Quality Rule url.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/DataSourcePrefix":{"id":"components/schemas/DataSourcePrefix","kind":"json-schema","title":"DataSourcePrefix","data":{"type":"string","description":"Identifies external Data Source.","example":"VIES"}},"components/schemas/BusinessPartnerStorageDataSourceId":{"id":"components/schemas/BusinessPartnerStorageDataSourceId","kind":"json-schema","title":"BusinessPartnerStorageDataSourceId","data":{"type":"string","description":"Unique identifier for a Data Source of the Storage.","example":"648824a691d8d2503d65103e"}},"components/schemas/CountryShortName":{"id":"components/schemas/CountryShortName","kind":"json-schema","title":"CountryShortName","data":{"type":"string","description":"Country code (ISO 3166-1 alpha-2).","example":"CH"}},"components/schemas/JobId":{"id":"components/schemas/JobId","kind":"json-schema","title":"JobId","data":{"type":"string","description":"Unique identifier of a job.","example":"35f23c03-1c22-45fe-9484-3ffe769325de"}},"components/schemas/CreatedAt":{"id":"components/schemas/CreatedAt","kind":"json-schema","title":"CreatedAt","data":{"type":"string","description":"Date of creation (ISO 8601-compliant).","example":"2026-11-10T13:37:16Z"}},"components/schemas/FinishedAt":{"id":"components/schemas/FinishedAt","kind":"json-schema","title":"FinishedAt","data":{"type":"string","description":"Date of finish (ISO 8601-compliant).","example":"2026-11-10T13:37:16Z"}},"components/schemas/JobUser":{"id":"components/schemas/JobUser","kind":"json-schema","title":"JobUser","data":{"type":"string","description":"ID of (human) user or API key.","example":"742429-234242-4343-232323"}},"components/schemas/JobProgress":{"id":"components/schemas/JobProgress","kind":"json-schema","title":"JobProgress","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Progress (%) of the job."},"children":[]}]}]}],"example":"77","maximum":100,"minimum":0}},"components/schemas/PropertyContent":{"id":"components/schemas/PropertyContent","kind":"json-schema","title":"PropertyContent","data":{"type":"string","description":"The current content of the property of the provided JSON.","example":"DE12345678"}},"components/schemas/PropertyContentSelector":{"id":"components/schemas/PropertyContentSelector","kind":"json-schema","title":"PropertyContentSelector","data":{"type":"string","description":"JSON path to the property in the provided JSON object.","example":"$.partnerProfile.minorityIndicator.value"}},"components/schemas/PropertyName":{"id":"components/schemas/PropertyName","kind":"json-schema","title":"PropertyName","data":{"type":"string","description":"Name of the property.","example":"Minority Indicator Value"}},"components/schemas/PropertyUrl":{"id":"components/schemas/PropertyUrl","kind":"json-schema","title":"PropertyUrl","data":{"type":"string","description":"External documentation URL for this property.","example":"http://meta.cdq.com/Business_Partner/Identifier_Value"}},"components/schemas/ConceptName":{"id":"components/schemas/ConceptName","kind":"json-schema","title":"ConceptName","data":{"type":"string","description":"Display name of the Concept.","example":"Address"}},"components/schemas/ConceptUrl":{"id":"components/schemas/ConceptUrl","kind":"json-schema","title":"ConceptUrl","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to the documentation which summarizes all details of the Business Partner "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/Business_partner"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concepts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://meta.cdq.com/Business_partner"}},"components/schemas/BusinessRuleName":{"id":"components/schemas/BusinessRuleName","kind":"json-schema","title":"BusinessRuleName","data":{"type":"string","description":"Represents business rule name.","example":"Identifier unknown (European value added tax identifier (The Netherlands))"}},"components/schemas/ValidationRuleStatus":{"id":"components/schemas/ValidationRuleStatus","kind":"json-schema","title":"ValidationRuleStatus","data":{"type":"string","description":"The status of a validation rule.","example":"RELEASED"}},"components/schemas/schemas-ViolationLevel":{"id":"components/schemas/schemas-ViolationLevel","kind":"json-schema","title":"schemas-ViolationLevel","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the criticality of the applied rule."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a data defect was found then user will get "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" level. Otherwise, it will be NO_DEFECT."},"children":[]}]}]}],"example":"INFO"}},"components/schemas/NameShortName":{"id":"components/schemas/NameShortName","kind":"json-schema","title":"NameShortName","data":{"type":"string","description":"The abbreviated variant of a company's full name.","example":"CDQ AG"}},"components/schemas/NameTypeUrl":{"id":"components/schemas/NameTypeUrl","kind":"json-schema","title":"NameTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the name type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/NameTypeName":{"id":"components/schemas/NameTypeName","kind":"json-schema","title":"NameTypeName","data":{"type":"string","description":"Display label for the Name Type.","example":"Local Name"}},"components/schemas/NameTypeTechnicalKey":{"id":"components/schemas/NameTypeTechnicalKey","kind":"json-schema","title":"NameTypeTechnicalKey","data":{"type":"string","description":"Technical Keys of the Name Type.","example":"LOCAL"}},"components/schemas/NameValue":{"id":"components/schemas/NameValue","kind":"json-schema","title":"NameValue","data":{"type":"string","description":"The actual name.","example":"Corporate Data Quality AG"}},"components/schemas/LanguageName":{"id":"components/schemas/LanguageName","kind":"json-schema","title":"LanguageName","data":{"type":"string","description":"ISO 639-1 name of language.","example":"German"}},"components/schemas/LanguageTechnicalKey":{"id":"components/schemas/LanguageTechnicalKey","kind":"json-schema","title":"LanguageTechnicalKey","data":{"type":"string","description":"ISO 639-1 two-letter code of languages.","example":"DE"}},"components/schemas/LegalFormName":{"id":"components/schemas/LegalFormName","kind":"json-schema","title":"LegalFormName","data":{"type":"string","description":"Display of the Legal Form.","example":"Aktiengesellschaft"}},"components/schemas/LegalFormMainAbbreviation":{"id":"components/schemas/LegalFormMainAbbreviation","kind":"json-schema","title":"LegalFormMainAbbreviation","data":{"type":"string","description":"The primary abbreviation of a legal form, i.e. the most commonly used abbreviation in a country.","example":"AG"}},"components/schemas/LegalFormCdlElfCode":{"id":"components/schemas/LegalFormCdlElfCode","kind":"json-schema","title":"LegalFormCdlElfCode","data":{"deprecated":true,"type":"string","description":"An unique identifier for CDL managed Legal Forms.","example":"AG"}},"components/schemas/LegalFormCategoryName":{"id":"components/schemas/LegalFormCategoryName","kind":"json-schema","title":"LegalFormCategoryName","data":{"type":"string","maxLength":40,"description":"Descriptive display name of the Legal Form Category.","example":"Limited Liability Company"}},"components/schemas/LegalFormCategoryShortName":{"id":"components/schemas/LegalFormCategoryShortName","kind":"json-schema","title":"LegalFormCategoryShortName","data":{"type":"string","maxLength":15,"description":"Short display name of the Legal Form Category.","example":"LLC"}},"components/schemas/LegalFormCategoryUrl":{"id":"components/schemas/LegalFormCategoryUrl","kind":"json-schema","title":"LegalFormCategoryUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the legal form category.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/LegalFormCategoryTechnicalKey":{"id":"components/schemas/LegalFormCategoryTechnicalKey","kind":"json-schema","title":"LegalFormCategoryTechnicalKey","data":{"type":"string","description":"Technical key of the legal form category.","example":"LIMITED"}},"components/schemas/LegalFormUrl":{"id":"components/schemas/LegalFormUrl","kind":"json-schema","title":"LegalFormUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of legal form.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/LegalFormTechnicalKey":{"id":"components/schemas/LegalFormTechnicalKey","kind":"json-schema","title":"LegalFormTechnicalKey","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical Key of a Legal Form. Descriptions of below enums contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country Scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"International Name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Main Abraviation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"DE_9866"}},"components/schemas/schemas-IdentifierValue":{"id":"components/schemas/schemas-IdentifierValue","kind":"json-schema","title":"schemas-IdentifierValue","data":{"type":"string","description":"Value of the identifier.","example":"CHE-218.608.886 HR/MWST"}},"components/schemas/IdentifierTypeUrl":{"id":"components/schemas/IdentifierTypeUrl","kind":"json-schema","title":"IdentifierTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of an identifier.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/IdentifierTypeName":{"id":"components/schemas/IdentifierTypeName","kind":"json-schema","title":"IdentifierTypeName","data":{"type":"string","description":"Display label for the Identifier.","example":"CH_VAT_ID"}},"components/schemas/schemas-IdentifierTypeTechnicalKey":{"id":"components/schemas/schemas-IdentifierTypeTechnicalKey","kind":"json-schema","title":"schemas-IdentifierTypeTechnicalKey","data":{"type":"string","description":"Technical key of the type of the Identifier.","example":"CH_VAT_ID"}},"components/schemas/IdentifierStatusName":{"id":"components/schemas/IdentifierStatusName","kind":"json-schema","title":"IdentifierStatusName","data":{"type":"string","description":"Display label for the Identifier Status Name.","example":"ACTIVE"}},"components/schemas/IdentifierStatusTypeUrl":{"id":"components/schemas/IdentifierStatusTypeUrl","kind":"json-schema","title":"IdentifierStatusTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the identifier status.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/IdentifierStatusTechnicalKey":{"id":"components/schemas/IdentifierStatusTechnicalKey","kind":"json-schema","title":"IdentifierStatusTechnicalKey","data":{"type":"string","description":"Technical key of the Identifier Status.","example":"ACTIVE"}},"components/schemas/IssuingBodyName":{"id":"components/schemas/IssuingBodyName","kind":"json-schema","title":"IssuingBodyName","data":{"type":"string","description":"Preferred display label for an Issuing Body.","example":"Amtsgericht Aachen"}},"components/schemas/IssuingBodyDescription":{"id":"components/schemas/IssuingBodyDescription","kind":"json-schema","title":"IssuingBodyDescription","data":{"type":"string","description":"Description for an Issuing Body.","example":"Amtsgericht Aachen"}},"components/schemas/IssuingBodyUrl":{"id":"components/schemas/IssuingBodyUrl","kind":"json-schema","title":"IssuingBodyUrl","data":{"description":"URL to the documentation which summarizes all details of an issuing body.","example":"https://meta.cdq.com/Public:CDQ_data_model","type":"string"}},"components/schemas/IssuingBodyTechnicalKey":{"id":"components/schemas/IssuingBodyTechnicalKey","kind":"json-schema","title":"IssuingBodyTechnicalKey","data":{"description":"Technical key of the Issuing Body.","example":"Amtsgericht Aachen","type":"string"}},"components/schemas/CountryValue":{"id":"components/schemas/CountryValue","kind":"json-schema","title":"CountryValue","data":{"type":"string","description":"Country name (ISO 3166-1 alpha-2).","example":"Switzerland"}},"components/schemas/AdministrativeAreaValue":{"id":"components/schemas/AdministrativeAreaValue","kind":"json-schema","title":"AdministrativeAreaValue","data":{"type":"string","description":"Name of the administrative area.","example":"Sankt Gallen"}},"components/schemas/AdministrativeAreaShortName":{"id":"components/schemas/AdministrativeAreaShortName","kind":"json-schema","title":"AdministrativeAreaShortName","data":{"type":"string","description":"Abbreviation for the administrative area.","example":"SG"}},"components/schemas/AdministrativeAreaFipsCode":{"id":"components/schemas/AdministrativeAreaFipsCode","kind":"json-schema","title":"AdministrativeAreaFipsCode","data":{"type":"string","description":"FIPS codes are numbers which uniquely identify geographic areas. The number of digits in FIPS codes vary depending on the level of geography. State-level FIPS codes have two digits, county-level FIPS codes have five digits of which the first two are the FIPS code of the state to which the county belongs.","example":"SZ15"}},"components/schemas/AdministrativeAreaIsoCode":{"id":"components/schemas/AdministrativeAreaIsoCode","kind":"json-schema","title":"AdministrativeAreaIsoCode","data":{"type":"string","description":"ISO 3166-2 code which uniquely defines the names of countries and their subdivisions (e.g., provinces or states).","example":"CH-SG"}},"components/schemas/AdministrativeAreaTypeName":{"id":"components/schemas/AdministrativeAreaTypeName","kind":"json-schema","title":"AdministrativeAreaTypeName","data":{"type":"string","description":"Display label for the Administrative Area Type.","example":"COUNTY"}},"components/schemas/AdministrativeAreaTypeUrl":{"id":"components/schemas/AdministrativeAreaTypeUrl","kind":"json-schema","title":"AdministrativeAreaTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the administrative area type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/AdministrativeAreaTypeTechnicalKey":{"id":"components/schemas/AdministrativeAreaTypeTechnicalKey","kind":"json-schema","title":"AdministrativeAreaTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Administrative Area.","example":"COUNTY"}},"components/schemas/IssuingBodyGleifCode":{"id":"components/schemas/IssuingBodyGleifCode","kind":"json-schema","title":"IssuingBodyGleifCode","data":{"type":"string","description":"Code of Global Legal Entity Identifier Foundation (GLEIF)","example":"RA000004"}},"components/schemas/IssuingBodyLocalAuthorityCode":{"id":"components/schemas/IssuingBodyLocalAuthorityCode","kind":"json-schema","title":"IssuingBodyLocalAuthorityCode","data":{"type":"string","description":"Code of the local registration authority","example":"R3101"}},"components/schemas/IssuingBodyExternalUrl":{"id":"components/schemas/IssuingBodyExternalUrl","kind":"json-schema","title":"IssuingBodyExternalUrl","data":{"type":"string","description":"External url of the issuing body","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/BusinessPartnerCategoryName":{"id":"components/schemas/BusinessPartnerCategoryName","kind":"json-schema","title":"BusinessPartnerCategoryName","data":{"type":"string","description":"Display name of the Business Partner Category Name.","example":"Hotel"}},"components/schemas/BusinessPartnerCategoryUrl":{"id":"components/schemas/BusinessPartnerCategoryUrl","kind":"json-schema","title":"BusinessPartnerCategoryUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the business partner category.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/BusinessPartnerCategoryTechnicalKey":{"id":"components/schemas/BusinessPartnerCategoryTechnicalKey","kind":"json-schema","title":"BusinessPartnerCategoryTechnicalKey","data":{"type":"string","description":"Technical Key of the Business Partner Category.","example":"HOTEL"}},"components/schemas/BusinessPartnerStatusOfficialDenotation":{"id":"components/schemas/BusinessPartnerStatusOfficialDenotation","kind":"json-schema","title":"BusinessPartnerStatusOfficialDenotation","data":{"type":"string","description":"The status as provided by an official register.","example":"Good Standing"}},"components/schemas/BusinessPartnerStatusValidFrom":{"id":"components/schemas/BusinessPartnerStatusValidFrom","kind":"json-schema","title":"BusinessPartnerStatusValidFrom","data":{"type":"string","description":"Describes since when a business partner turned or will turn into the provided status. If no official date is known, the date of changing the status in the CDQ Community Data Pool or an external data source is provided.","example":"2026-11-10T13:37:16Z"}},"components/schemas/BusinessPartnerStatusValidUntil":{"id":"components/schemas/BusinessPartnerStatusValidUntil","kind":"json-schema","title":"BusinessPartnerStatusValidUntil","data":{"type":"string","description":"Describes until when a business partner had a certain status. If no official date is known, the date of changing the status in the CDQ Community Data Pool or an external data source is provided.","example":"2026-11-10T13:37:16Z"}},"components/schemas/BusinessPartnerStatusTypeName":{"id":"components/schemas/BusinessPartnerStatusTypeName","kind":"json-schema","title":"BusinessPartnerStatusTypeName","data":{"type":"string","description":"Display name of the Business Partner Status.","example":"In Liquidation"}},"components/schemas/BusinessPartnerStatusTypeUrl":{"id":"components/schemas/BusinessPartnerStatusTypeUrl","kind":"json-schema","title":"BusinessPartnerStatusTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the business partner status.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/BusinessPartnerStatusTypeTechnicalKey":{"id":"components/schemas/BusinessPartnerStatusTypeTechnicalKey","kind":"json-schema","title":"BusinessPartnerStatusTypeTechnicalKey","data":{"type":"string","description":"Technical Key of the Business Parter Status.","example":"IN_LIQUIDATION"}},"components/schemas/CharacterSetName":{"id":"components/schemas/CharacterSetName","kind":"json-schema","title":"CharacterSetName","data":{"type":"string","description":"Name of character set. Supported character sets can be found here.","example":"International"}},"components/schemas/CharacterSetTechnicalKey":{"id":"components/schemas/CharacterSetTechnicalKey","kind":"json-schema","title":"CharacterSetTechnicalKey","data":{"type":"string","description":"Technical key of character set. Supported character sets can be found here.","example":"INTERNATIONAL"}},"components/schemas/CharacterSet":{"id":"components/schemas/CharacterSet","kind":"json-schema","title":"CharacterSet","data":{"type":"object","description":"Character set.","properties":{"name":{"$ref":"#/components/schemas/CharacterSetName"},"technicalKey":{"$ref":"#/components/schemas/CharacterSetTechnicalKey"}}}},"components/schemas/AddressIdentifyingNameValue":{"id":"components/schemas/AddressIdentifyingNameValue","kind":"json-schema","title":"AddressIdentifyingNameValue","data":{"type":"string","description":"An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent.","example":"John Doe"}},"components/schemas/AddressExternalId":{"id":"components/schemas/AddressExternalId","kind":"json-schema","title":"AddressExternalId","data":{"type":"string","description":"ID the address has in the external system where the record originates from.","example":"1"}},"components/schemas/ProvenanceName":{"id":"components/schemas/ProvenanceName","kind":"json-schema","title":"ProvenanceName","data":{"type":"string","description":"Display Name of the Provenance Name.","example":"VIES"}},"components/schemas/ProvenanceUrl":{"id":"components/schemas/ProvenanceUrl","kind":"json-schema","title":"ProvenanceUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the Provenance Name.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/ProvenanceTechnicalKey":{"id":"components/schemas/ProvenanceTechnicalKey","kind":"json-schema","title":"ProvenanceTechnicalKey","data":{"type":"string","description":"Technical Key of the Provenance Name.","example":"VIES"}},"components/schemas/ProvenanceCdqId":{"id":"components/schemas/ProvenanceCdqId","kind":"json-schema","title":"ProvenanceCdqId","data":{"type":"string","description":"The ID provided for a linkage with the source by CDQ.","example":"VIES:PL8660001429"}},"components/schemas/CareOfValue":{"id":"components/schemas/CareOfValue","kind":"json-schema","title":"CareOfValue","data":{"type":"string","description":"Value of the CareOf.","example":"CDQ GmbH c/o Product Department"}},"components/schemas/AddressContextValue":{"id":"components/schemas/AddressContextValue","kind":"json-schema","title":"AddressContextValue","data":{"type":"string","description":"Value of the Address Context.","example":"Production hall 7, Storage field 8."}},"components/schemas/PostCodeValue":{"id":"components/schemas/PostCodeValue","kind":"json-schema","title":"PostCodeValue","data":{"type":"string","description":"Effective post code.","example":"9000"}},"components/schemas/PostCodeTypeName":{"id":"components/schemas/PostCodeTypeName","kind":"json-schema","title":"PostCodeTypeName","data":{"type":"string","description":"Display label for the Post Code Type.","example":"Regular"}},"components/schemas/PostCodeTypeUrl":{"id":"components/schemas/PostCodeTypeUrl","kind":"json-schema","title":"PostCodeTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the administrative area.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/PostCodeTypeTechnicalKey":{"id":"components/schemas/PostCodeTypeTechnicalKey","kind":"json-schema","title":"PostCodeTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Post Code.","example":"REGULAR"}},"components/schemas/LocalityTypeName":{"id":"components/schemas/LocalityTypeName","kind":"json-schema","title":"LocalityTypeName","data":{"type":"string","description":"Display label for the Locality Type.","example":"City"}},"components/schemas/LocalityTypeUrl":{"id":"components/schemas/LocalityTypeUrl","kind":"json-schema","title":"LocalityTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the locality type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/LocalityTypeTechnicalKey":{"id":"components/schemas/LocalityTypeTechnicalKey","kind":"json-schema","title":"LocalityTypeTechnicalKey","data":{"type":"string","description":"Technical Key of the Locality Type.","example":"CITY"}},"components/schemas/LocalityShortName":{"id":"components/schemas/LocalityShortName","kind":"json-schema","title":"LocalityShortName","data":{"type":"string","description":"Abbreviation of the locality.","example":"St. Gallen"}},"components/schemas/LocalityValue":{"id":"components/schemas/LocalityValue","kind":"json-schema","title":"LocalityValue","data":{"type":"string","description":"Name of the locality.","example":"Sankt Gallen"}},"components/schemas/ThoroughfareTypeName":{"id":"components/schemas/ThoroughfareTypeName","kind":"json-schema","title":"ThoroughfareTypeName","data":{"type":"string","description":"Display label for the Thoroughfare Type Name.","example":"Industrial zone"}},"components/schemas/ThoroughfareTypeUrl":{"id":"components/schemas/ThoroughfareTypeUrl","kind":"json-schema","title":"ThoroughfareTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the thoroughfare type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/ThoroughfareTypeTechnicalKey":{"id":"components/schemas/ThoroughfareTypeTechnicalKey","kind":"json-schema","title":"ThoroughfareTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Thoroughfare Type.","example":"INDUSTRIAL_ZONE"}},"components/schemas/ThoroughfareShortName":{"id":"components/schemas/ThoroughfareShortName","kind":"json-schema","title":"ThoroughfareShortName","data":{"type":"string","description":"Abbreviation of the thoroughfare.","example":"Lukasstr. 4"}},"components/schemas/ThoroughfareNumber":{"id":"components/schemas/ThoroughfareNumber","kind":"json-schema","title":"ThoroughfareNumber","data":{"type":"string","description":"Number of the thoroughfare.","example":"4"}},"components/schemas/ThoroughfareValue":{"id":"components/schemas/ThoroughfareValue","kind":"json-schema","title":"ThoroughfareValue","data":{"type":"string","description":"Comprehensive designation of the thoroughfare including the thoroughfare type such as Street, or Rue.","example":"Lukasstraße 4"}},"components/schemas/ThoroughfareName":{"id":"components/schemas/ThoroughfareName","kind":"json-schema","title":"ThoroughfareName","data":{"type":"string","description":"Pure name of the thoroughfare not comprising the thoroughfare type such as Street, or Rue.","example":"Lukasstraße"}},"components/schemas/ThoroughfareDirection":{"id":"components/schemas/ThoroughfareDirection","kind":"json-schema","title":"ThoroughfareDirection","data":{"type":"string","description":"Direction of the thoroughfare.","example":"221-bis Baker Street, North"}},"components/schemas/PremiseValue":{"id":"components/schemas/PremiseValue","kind":"json-schema","title":"PremiseValue","data":{"type":"string","description":"The actual value of a Premise in the language of the address.","example":"Lukasstraße 4"}},"components/schemas/PremiseShortName":{"id":"components/schemas/PremiseShortName","kind":"json-schema","title":"PremiseShortName","data":{"type":"string","description":"Abbreviation of the Premise.","example":"Lukasstr. 4"}},"components/schemas/PremiseNumber":{"id":"components/schemas/PremiseNumber","kind":"json-schema","title":"PremiseNumber","data":{"type":"string","description":"Number of the Premise.","example":"4"}},"components/schemas/PremiseTypeName":{"id":"components/schemas/PremiseTypeName","kind":"json-schema","title":"PremiseTypeName","data":{"type":"string","description":"Display label for the Premise Type.","example":"Factory"}},"components/schemas/PremiseTypeUrl":{"id":"components/schemas/PremiseTypeUrl","kind":"json-schema","title":"PremiseTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the premise type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/PremiseTypeTechnicalKey":{"id":"components/schemas/PremiseTypeTechnicalKey","kind":"json-schema","title":"PremiseTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Premise Type.","example":"FACTORY"}},"components/schemas/PostalDeliveryPointTypeName":{"id":"components/schemas/PostalDeliveryPointTypeName","kind":"json-schema","title":"PostalDeliveryPointTypeName","data":{"type":"string","description":"Display label for the Postal Delivery Point Type.","example":"Mailbox"}},"components/schemas/PostalDeliveryPointTypeUrl":{"id":"components/schemas/PostalDeliveryPointTypeUrl","kind":"json-schema","title":"PostalDeliveryPointTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the postal delivery point.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/PostalDeliveryPointTypeTechnicalKey":{"id":"components/schemas/PostalDeliveryPointTypeTechnicalKey","kind":"json-schema","title":"PostalDeliveryPointTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Postal Delivery Point.","example":"MAILBOX"}},"components/schemas/PostalDeliveryPointShortName":{"id":"components/schemas/PostalDeliveryPointShortName","kind":"json-schema","title":"PostalDeliveryPointShortName","data":{"type":"string","description":"Stort name of the postal delivery point.","example":"St Gallen, Postfach 460"}},"components/schemas/PostalDeliveryPointNumber":{"id":"components/schemas/PostalDeliveryPointNumber","kind":"json-schema","title":"PostalDeliveryPointNumber","data":{"type":"string","description":"Number of the postal delivery point.","example":"460"}},"components/schemas/PostalDeliveryPointValue":{"id":"components/schemas/PostalDeliveryPointValue","kind":"json-schema","title":"PostalDeliveryPointValue","data":{"type":"string","description":"Value of the postal delivery point.","example":"Postfach"}},"components/schemas/OpeningHour":{"id":"components/schemas/OpeningHour","kind":"json-schema","title":"OpeningHour","data":{"type":"object","description":"Time range in which the company is open.","properties":{"openingHour":{"type":"string","description":"Company openning hour.","example":"09:00 AM"},"closingHour":{"type":"string","description":"Company closing hour.","example":"05:00 PM"},"weekday":{"type":"string","description":"A day in the week in which the company is open.","example":"Monday"}}}},"components/schemas/GeographicCoordinatesLatitude":{"id":"components/schemas/GeographicCoordinatesLatitude","kind":"json-schema","title":"GeographicCoordinatesLatitude","data":{"description":"Plain on the earth's surface north or south of the equator.","example":"47.439549","type":"number","format":"double"}},"components/schemas/GeographicCoordinatesLongitude":{"id":"components/schemas/GeographicCoordinatesLongitude","kind":"json-schema","title":"GeographicCoordinatesLongitude","data":{"description":"Plain on the earth's surface east or west of a meridian.","example":"9.395275","type":"number","format":"double"}},"components/schemas/AddressTypeName":{"id":"components/schemas/AddressTypeName","kind":"json-schema","title":"AddressTypeName","data":{"type":"string","description":"Display label for the Address Type.","example":"Legal Address"}},"components/schemas/AddressTypeUrl":{"id":"components/schemas/AddressTypeUrl","kind":"json-schema","title":"AddressTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the address type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/AddressTypeTechnicalKey":{"id":"components/schemas/AddressTypeTechnicalKey","kind":"json-schema","title":"AddressTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Address Type.","example":"LEGAL_ADDRESS"}},"components/schemas/FormattedAddressCountry":{"id":"components/schemas/FormattedAddressCountry","kind":"json-schema","title":"FormattedAddressCountry","data":{"type":"string","description":"Country name.","example":"Switzerland"}},"components/schemas/FormattedAddressAdministrativeArea":{"id":"components/schemas/FormattedAddressAdministrativeArea","kind":"json-schema","title":"FormattedAddressAdministrativeArea","data":{"type":"string","description":"A top-level geographical or political area division in a country.","example":"Sankt Gallen"}},"components/schemas/FormattedAddressRegion":{"id":"components/schemas/FormattedAddressRegion","kind":"json-schema","title":"FormattedAddressRegion","data":{"type":"string","description":"Top level subdivision of a country.","example":"Sankt Gallen"}},"components/schemas/FormattedAddressRegionCode":{"id":"components/schemas/FormattedAddressRegionCode","kind":"json-schema","title":"FormattedAddressRegionCode","data":{"type":"string","description":"A country specific code for a certain address in the region.","example":"9004"}},"components/schemas/FormattedAddressLocality":{"id":"components/schemas/FormattedAddressLocality","kind":"json-schema","title":"FormattedAddressLocality","data":{"type":"string","description":"A locality is a named densely populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses.","example":"Sankt Gallen"}},"components/schemas/FormattedAddressDistrict":{"id":"components/schemas/FormattedAddressDistrict","kind":"json-schema","title":"FormattedAddressDistrict","data":{"type":"string","description":"Type of administrative division that, in some countries, is managed by local government. Across the world, areas known as \"districts\" vary greatly in size, spanning regions or counties, several municipalities, subdivisions of municipalities, school district, or political district.","example":"City center"}},"components/schemas/FormattedAddressPostalCode":{"id":"components/schemas/FormattedAddressPostalCode","kind":"json-schema","title":"FormattedAddressPostalCode","data":{"type":"string","description":"A country specific code for a certain address.","example":"9000"}},"components/schemas/FormattedAddressThoroughfare":{"id":"components/schemas/FormattedAddressThoroughfare","kind":"json-schema","title":"FormattedAddressThoroughfare","data":{"type":"string","description":"Details of the access route along which buildings, lots, or land are located, such as street, road, channel, crescent, avenue.","example":"Lukassstrasse"}},"components/schemas/FormattedAddressPremise":{"id":"components/schemas/FormattedAddressPremise","kind":"json-schema","title":"FormattedAddressPremise","data":{"type":"string","description":"A premise is a tract of land including its buildings. A premise may have several sub-levels to precisely identify.","example":"Lukasstraße 4, Building 2, Floor 3, Room 4"}},"components/schemas/FormattedAddressInterurbanDeliveryPoint":{"id":"components/schemas/FormattedAddressInterurbanDeliveryPoint","kind":"json-schema","title":"FormattedAddressInterurbanDeliveryPoint","data":{"type":"string","description":"A single mailbox or other place at which postal mail is delivered.","example":"Sankt Gallen, Postfach 460"}},"components/schemas/FormattedAddressMailbox":{"id":"components/schemas/FormattedAddressMailbox","kind":"json-schema","title":"FormattedAddressMailbox","data":{"type":"string","description":"A location at an address where the post is delivered to.","example":"Postfach 460"}},"components/schemas/FormattedAddressPostOfficeBox":{"id":"components/schemas/FormattedAddressPostOfficeBox","kind":"json-schema","title":"FormattedAddressPostOfficeBox","data":{"type":"string","description":"A uniquely addressable lockable box located on the premises of a post office station.","example":"Postfach 460"}},"components/schemas/BusinessPartnerExternalId":{"id":"components/schemas/BusinessPartnerExternalId","kind":"json-schema","title":"BusinessPartnerExternalId","data":{"type":"string","description":"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."}},"components/schemas/MinorityIndicatorValue":{"id":"components/schemas/MinorityIndicatorValue","kind":"json-schema","title":"MinorityIndicatorValue","data":{"type":"string","description":"The actual value of the minority indicator, representing the minority group.","example":"Social enterprise"}},"components/schemas/ClassificationValue":{"id":"components/schemas/ClassificationValue","kind":"json-schema","title":"ClassificationValue","data":{"type":"string","description":"A textual description of the Classification.","example":"Manufacture of pesticides and other agrochemical products."}},"components/schemas/ClassificationCode":{"id":"components/schemas/ClassificationCode","kind":"json-schema","title":"ClassificationCode","data":{"type":"string","description":"Code that classifies the business partner.","example":"20.20Z"}},"components/schemas/ClassificationLevel":{"id":"components/schemas/ClassificationLevel","kind":"json-schema","title":"ClassificationLevel","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the hierarchy of classification codes. E.g. whether the industry code is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code."},"children":[]}]}]}],"example":"primary"}},"components/schemas/ClassificationTypeName":{"id":"components/schemas/ClassificationTypeName","kind":"json-schema","title":"ClassificationTypeName","data":{"type":"string","description":"Display label for the Classification Type.","example":"NAF 2003"}},"components/schemas/ClassificationTypeUrl":{"id":"components/schemas/ClassificationTypeUrl","kind":"json-schema","title":"ClassificationTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the classification type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/ClassificationTypeTechnicalKey":{"id":"components/schemas/ClassificationTypeTechnicalKey","kind":"json-schema","title":"ClassificationTypeTechnicalKey","data":{"type":"string","description":"TechnicalKey for the Classification Type.","example":"NAF_2003"}},"components/schemas/ClassificationType":{"id":"components/schemas/ClassificationType","kind":"json-schema","title":"ClassificationType","data":{"type":"object","description":"Type of classification such as NACE, SIC, NAF or other industry classification standards.","properties":{"name":{"$ref":"#/components/schemas/ClassificationTypeName"},"url":{"$ref":"#/components/schemas/ClassificationTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/ClassificationTypeTechnicalKey"}}}},"components/schemas/PhoneNumberCountryPrefix":{"id":"components/schemas/PhoneNumberCountryPrefix","kind":"json-schema","title":"PhoneNumberCountryPrefix","data":{"type":"string","description":"The country prefix of a phone number.","example":"+41"}},"components/schemas/PhoneNumberNumber":{"id":"components/schemas/PhoneNumberNumber","kind":"json-schema","title":"PhoneNumberNumber","data":{"type":"string","description":"The complete phone number without any country prefixes.","example":"71 571 10 40"}},"components/schemas/PhoneNumberTypeName":{"id":"components/schemas/PhoneNumberTypeName","kind":"json-schema","title":"PhoneNumberTypeName","data":{"type":"string","description":"Display label for a Phone Number Type Name.","example":"FAX"}},"components/schemas/PhoneNumberTypeUrl":{"id":"components/schemas/PhoneNumberTypeUrl","kind":"json-schema","title":"PhoneNumberTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the phone number type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/PhoneNumberTypeTechnicalKey":{"id":"components/schemas/PhoneNumberTypeTechnicalKey","kind":"json-schema","title":"PhoneNumberTypeTechnicalKey","data":{"type":"string","description":"Technical Keys of the PhoneNumber.","example":"FAX"}},"components/schemas/PhoneNumberType":{"id":"components/schemas/PhoneNumberType","kind":"json-schema","title":"PhoneNumberType","data":{"type":"object","description":"The type of a phone number such as mobile phone or fixed line.","properties":{"name":{"$ref":"#/components/schemas/PhoneNumberTypeName"},"url":{"$ref":"#/components/schemas/PhoneNumberTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/PhoneNumberTypeTechnicalKey"}}}},"components/schemas/PhoneNumberValue":{"id":"components/schemas/PhoneNumberValue","kind":"json-schema","title":"PhoneNumberValue","data":{"type":"string","description":"The actual complete phone number incl. country prefix.","example":"+41 71 571 10 40"}},"components/schemas/WebsiteUrl":{"id":"components/schemas/WebsiteUrl","kind":"json-schema","title":"WebsiteUrl","data":{"type":"string","description":"The actual company website URL.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/WebsiteTypeName":{"id":"components/schemas/WebsiteTypeName","kind":"json-schema","title":"WebsiteTypeName","data":{"type":"string","description":"Display label for a Website Type Name","example":"Corporate Website"}},"components/schemas/WebsiteTypeUrl":{"id":"components/schemas/WebsiteTypeUrl","kind":"json-schema","title":"WebsiteTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes website type name.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/WebsiteTypeTechnicalKey":{"id":"components/schemas/WebsiteTypeTechnicalKey","kind":"json-schema","title":"WebsiteTypeTechnicalKey","data":{"type":"string","description":"Technical Keys of the Website Type Name.","example":"WEBSITE_TYPE_CORPORATE"}},"components/schemas/schemas-WebsiteType":{"id":"components/schemas/schemas-WebsiteType","kind":"json-schema","title":"schemas-WebsiteType","data":{"type":"object","description":"Describes the type of website of a business partner, e.g. corporate website, official LinkedIn profile, etc.","properties":{"name":{"$ref":"#/components/schemas/WebsiteTypeName"},"url":{"$ref":"#/components/schemas/WebsiteTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/WebsiteTypeTechnicalKey"}}}},"components/schemas/ContactEmailValue":{"id":"components/schemas/ContactEmailValue","kind":"json-schema","title":"ContactEmailValue","data":{"type":"string","description":"Value of the email address of the Business Partner.","example":"developer-portal@cdq.com"}},"components/schemas/TagValue":{"id":"components/schemas/TagValue","kind":"json-schema","title":"TagValue","data":{"type":"string","description":"Value of the tag.","example":"Warehouse"}},"components/schemas/TagTypeTechnicalKey":{"id":"components/schemas/TagTypeTechnicalKey","kind":"json-schema","title":"TagTypeTechnicalKey","data":{"type":"string","description":"Technical Key of the Tag.","example":"WAREHOUSE"}},"components/schemas/TagType":{"id":"components/schemas/TagType","kind":"json-schema","title":"TagType","data":{"description":"A type that specifies the nature of the tag.","type":"object","properties":{"technicalKey":{"$ref":"#/components/schemas/TagTypeTechnicalKey"}}}},"components/schemas/Tag":{"id":"components/schemas/Tag","kind":"json-schema","title":"Tag","data":{"type":"object","description":"Describing and identifying a resource. Custom information about the resource in form of a tag.","properties":{"value":{"$ref":"#/components/schemas/TagValue"},"type":{"$ref":"#/components/schemas/TagType"}}}},"components/schemas/Tags":{"id":"components/schemas/Tags","kind":"json-schema","title":"Tags","data":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}},"components/schemas/FormattedSapRecordName1":{"id":"components/schemas/FormattedSapRecordName1","kind":"json-schema","title":"FormattedSapRecordName1","data":{"type":"string","description":"A name1 filed of a business partner name.","example":"CDQ AG"}},"components/schemas/FormattedSapRecordName2":{"id":"components/schemas/FormattedSapRecordName2","kind":"json-schema","title":"FormattedSapRecordName2","data":{"type":"string","description":"A name2 filed of a business partner name.","example":"CDQ AG"}},"components/schemas/FormattedSapRecordName3":{"id":"components/schemas/FormattedSapRecordName3","kind":"json-schema","title":"FormattedSapRecordName3","data":{"type":"string","description":"A name3 filed of a business partner name.","example":"CDQ AG"}},"components/schemas/FormattedSapRecordName4":{"id":"components/schemas/FormattedSapRecordName4","kind":"json-schema","title":"FormattedSapRecordName4","data":{"type":"string","description":"A name4 filed of a business partner name.","example":"CDQ AG"}},"components/schemas/FormattedSapRecordNameCo":{"id":"components/schemas/FormattedSapRecordNameCo","kind":"json-schema","title":"FormattedSapRecordNameCo","data":{"type":"string","description":"The legal form name of a Legal Form.","example":"Aktiengesellschaft"}},"components/schemas/FormattedSapRecordLegalEntity":{"id":"components/schemas/FormattedSapRecordLegalEntity","kind":"json-schema","title":"FormattedSapRecordLegalEntity","data":{"type":"string","description":"The legal entity of a Legal Form.","example":"Aktiengesellschaft"}},"components/schemas/FormattedSapRecordLegalForm":{"id":"components/schemas/FormattedSapRecordLegalForm","kind":"json-schema","title":"FormattedSapRecordLegalForm","data":{"type":"string","description":"The legal form of a Legal Form.","example":"Aktiengesellschaft"}},"components/schemas/FormattedSapRecordIndSector":{"id":"components/schemas/FormattedSapRecordIndSector","kind":"json-schema","title":"FormattedSapRecordIndSector","data":{"type":"string","description":"A business industry or activity classification is a system of categorizing businesses and organizations into specific industries or activities based on their primary products or services, functions, or activities. These classifications are often used by governments, trade organizations, and other institutions to collect and analyze data on economic activity and to track trends and changes in various sectors.","example":"NAF"}},"components/schemas/FormattedSapRecordNarp":{"id":"components/schemas/FormattedSapRecordNarp","kind":"json-schema","title":"FormattedSapRecordNarp","data":{"type":"string","description":"An individual person, i.e. not an organization. An individual has no identifiers and has no legal form in its name.","example":"Friedrich Nietzsche"}},"components/schemas/FormattedSapRecordStceg":{"id":"components/schemas/FormattedSapRecordStceg","kind":"json-schema","title":"FormattedSapRecordStceg","data":{"type":"string","description":"VAT registration number.","example":"CHE-218.608.88"}},"components/schemas/FormattedSapRecordStcd1":{"id":"components/schemas/FormattedSapRecordStcd1","kind":"json-schema","title":"FormattedSapRecordStcd1","data":{"type":"string","description":"Standard tax number field1.","example":"CHE-218.608.88"}},"components/schemas/FormattedSapRecordStcd2":{"id":"components/schemas/FormattedSapRecordStcd2","kind":"json-schema","title":"FormattedSapRecordStcd2","data":{"type":"string","description":"Standard tax number field2.","example":"CHE-218.608.88"}},"components/schemas/FormattedSapRecordStcd3":{"id":"components/schemas/FormattedSapRecordStcd3","kind":"json-schema","title":"FormattedSapRecordStcd3","data":{"type":"string","description":"Standard tax number field3.","example":"CHE-218.608.88"}},"components/schemas/FormattedSapRecordStcd4":{"id":"components/schemas/FormattedSapRecordStcd4","kind":"json-schema","title":"FormattedSapRecordStcd4","data":{"type":"string","description":"Standard tax number field4.","example":"CHE-218.608.88"}},"components/schemas/FormattedSapRecordStcd5":{"id":"components/schemas/FormattedSapRecordStcd5","kind":"json-schema","title":"FormattedSapRecordStcd5","data":{"type":"string","description":"Standard tax number field5.","example":"CHE-218.608.88"}},"components/schemas/FormattedSapRecordUrl":{"id":"components/schemas/FormattedSapRecordUrl","kind":"json-schema","title":"FormattedSapRecordUrl","data":{"type":"string","description":"Webpages related to the business partner, e.g. the main corporate website as also provided by some company registers.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/FormattedSapRecordTelNumber":{"id":"components/schemas/FormattedSapRecordTelNumber","kind":"json-schema","title":"FormattedSapRecordTelNumber","data":{"type":"string","description":"The main phone number of a business partner, usually some info-line of the headquarter.","example":"+41 71 571 10 40"}},"components/schemas/FormattedSapRecordCountry":{"id":"components/schemas/FormattedSapRecordCountry","kind":"json-schema","title":"FormattedSapRecordCountry","data":{"type":"string","description":"Country name.","example":"Switzerland"}},"components/schemas/FormattedSapRecordCountryCode":{"id":"components/schemas/FormattedSapRecordCountryCode","kind":"json-schema","title":"FormattedSapRecordCountryCode","data":{"type":"string","description":"Country code (ISO 3166-1 alpha-2)","example":"CH"}},"components/schemas/FormattedSapRecordRegion":{"id":"components/schemas/FormattedSapRecordRegion","kind":"json-schema","title":"FormattedSapRecordRegion","data":{"type":"string","description":"A top-level geographical or political area division in a country.","example":"Sankt Gallen"}},"components/schemas/FormattedSapRecordRegionCodeSap":{"id":"components/schemas/FormattedSapRecordRegionCodeSap","kind":"json-schema","title":"FormattedSapRecordRegionCodeSap","data":{"type":"string","description":"A Region specific code for a certain address.","example":"9004"}},"components/schemas/FormattedSapRecordRegionCode":{"id":"components/schemas/FormattedSapRecordRegionCode","kind":"json-schema","title":"FormattedSapRecordRegionCode","data":{"type":"string","description":"A country specific code for a certain address in the region.","example":"9004"}},"components/schemas/FormattedSapRecordCounty":{"id":"components/schemas/FormattedSapRecordCounty","kind":"json-schema","title":"FormattedSapRecordCounty","data":{"type":"string","description":"A sub-level geographical or political area division in a country.","example":"Sankt Gallen"}},"components/schemas/FormattedSapRecordCountyCode":{"id":"components/schemas/FormattedSapRecordCountyCode","kind":"json-schema","title":"FormattedSapRecordCountyCode","data":{"type":"string","description":"A county specific code for a certain address in the region.","example":"9004"}},"components/schemas/FormattedSapRecordTownship":{"id":"components/schemas/FormattedSapRecordTownship","kind":"json-schema","title":"FormattedSapRecordTownship","data":{"type":"string","description":"A sub-level geographical or political area division in a country.","example":"Sankt Gallen"}},"components/schemas/FormattedSapRecordTownshipCode":{"id":"components/schemas/FormattedSapRecordTownshipCode","kind":"json-schema","title":"FormattedSapRecordTownshipCode","data":{"type":"string","description":"A township specific code for a certain address in the region.","example":"9004"}},"components/schemas/FormattedSapRecordCity":{"id":"components/schemas/FormattedSapRecordCity","kind":"json-schema","title":"FormattedSapRecordCity","data":{"type":"string","description":"A locality is a named densely populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses. Many localities exist in an administrative area. A locality can also have several levels of sub localities.","example":"Sankt Gallen"}},"components/schemas/FormattedSapRecordDistrict":{"id":"components/schemas/FormattedSapRecordDistrict","kind":"json-schema","title":"FormattedSapRecordDistrict","data":{"type":"string","description":"Area of a country or city.","example":"St. Georgen"}},"components/schemas/FormattedSapRecordPostalCode":{"id":"components/schemas/FormattedSapRecordPostalCode","kind":"json-schema","title":"FormattedSapRecordPostalCode","data":{"type":"string","description":"A country specific code for a certain address.","example":"9000"}},"components/schemas/FormattedSapRecordPostalCode3":{"id":"components/schemas/FormattedSapRecordPostalCode3","kind":"json-schema","title":"FormattedSapRecordPostalCode3","data":{"type":"string","description":"A country specific code for a certain address.","example":"9000"}},"components/schemas/FormattedSapRecordStreet1":{"id":"components/schemas/FormattedSapRecordStreet1","kind":"json-schema","title":"FormattedSapRecordStreet1","data":{"type":"string","description":"Details of the access route along which buildings, lots, or land are located, such as street, road, channel, crescent, avenue, etc. This also includes canals or banks on which houses or boat houses are located where people live.","example":"Lukasstraße 4"}},"components/schemas/FormattedSapRecordStreet2":{"id":"components/schemas/FormattedSapRecordStreet2","kind":"json-schema","title":"FormattedSapRecordStreet2","data":{"type":"string","description":"Additional street filed.","example":"Lukasstraße 4"}},"components/schemas/FormattedSapRecordStreet5":{"id":"components/schemas/FormattedSapRecordStreet5","kind":"json-schema","title":"FormattedSapRecordStreet5","data":{"type":"string","description":"Additional street filed.","example":"Lukasstraße 4"}},"components/schemas/FormattedSapRecordHouseNum":{"id":"components/schemas/FormattedSapRecordHouseNum","kind":"json-schema","title":"FormattedSapRecordHouseNum","data":{"type":"string","description":"Number of the Thoroughfare.","example":"4"}},"components/schemas/FormattedSapRecordHouseNum2":{"id":"components/schemas/FormattedSapRecordHouseNum2","kind":"json-schema","title":"FormattedSapRecordHouseNum2","data":{"type":"string","description":"Additional number filed.","example":"4"}},"components/schemas/FormattedSapRecordBuilding":{"id":"components/schemas/FormattedSapRecordBuilding","kind":"json-schema","title":"FormattedSapRecordBuilding","data":{"type":"string","description":"A structure (such as a house, hospital, school, etc.) with a roof and walls that is used as a place for people to live, work, do activities, store things, etc.","example":"Office 2"}},"components/schemas/FormattedSapRecordFloor":{"id":"components/schemas/FormattedSapRecordFloor","kind":"json-schema","title":"FormattedSapRecordFloor","data":{"type":"string","description":"The floor/story of the building.","example":"2"}},"components/schemas/FormattedSapRecordRoomnumber":{"id":"components/schemas/FormattedSapRecordRoomnumber","kind":"json-schema","title":"FormattedSapRecordRoomnumber","data":{"type":"string","description":"A distinct room in a building.","example":"123"}},"components/schemas/FormattedSapRecordPoBoxCountry":{"id":"components/schemas/FormattedSapRecordPoBoxCountry","kind":"json-schema","title":"FormattedSapRecordPoBoxCountry","data":{"type":"string","description":"A location at an address where the post is delivered to.","example":"9000"}},"components/schemas/FormattedSapRecordPoBoxCity":{"id":"components/schemas/FormattedSapRecordPoBoxCity","kind":"json-schema","title":"FormattedSapRecordPoBoxCity","data":{"type":"string","description":"A location at an address where the post is delivered to.","example":"9000"}},"components/schemas/FormattedSapRecordPoBoxPostalCode":{"id":"components/schemas/FormattedSapRecordPoBoxPostalCode","kind":"json-schema","title":"FormattedSapRecordPoBoxPostalCode","data":{"type":"string","description":"A location at an address where the post is delivered to.","example":"9000"}},"components/schemas/FormattedSapRecordPoBox":{"id":"components/schemas/FormattedSapRecordPoBox","kind":"json-schema","title":"FormattedSapRecordPoBox","data":{"type":"string","description":"Des","example":"9000"}},"components/schemas/FormattedSapRecordLatitude":{"id":"components/schemas/FormattedSapRecordLatitude","kind":"json-schema","title":"FormattedSapRecordLatitude","data":{"type":"string","description":"Plain on the earth's surface north or south of the equator.","example":"47.439549"}},"components/schemas/FormattedSapRecordLongitude":{"id":"components/schemas/FormattedSapRecordLongitude","kind":"json-schema","title":"FormattedSapRecordLongitude","data":{"type":"string","description":"Plain on the earth's surface east or west of a meridian.","example":"9.395275"}},"components/schemas/BusinessPartnerRelationStartedAt":{"id":"components/schemas/BusinessPartnerRelationStartedAt","kind":"json-schema","title":"BusinessPartnerRelationStartedAt","data":{"type":"string","description":"Describe when this relationship was first established.","example":"2026-11-10T13:37:16Z"}},"components/schemas/BusinessPartnerRelationEndedAt":{"id":"components/schemas/BusinessPartnerRelationEndedAt","kind":"json-schema","title":"BusinessPartnerRelationEndedAt","data":{"type":"string","description":"Describe when this relationship ended.","example":"2026-11-10T13:37:16Z"}},"components/schemas/BusinessPartnerRelationTypeName":{"id":"components/schemas/BusinessPartnerRelationTypeName","kind":"json-schema","title":"BusinessPartnerRelationTypeName","data":{"type":"string","description":"Display name of the Business Partner Relation Type.","example":"Commercial ultimate"}},"components/schemas/BusinessPartnerRelationTypeUrl":{"id":"components/schemas/BusinessPartnerRelationTypeUrl","kind":"json-schema","title":"BusinessPartnerRelationTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of a business partner relation type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/BusinessPartnerRelationTypeTechnicalKey":{"id":"components/schemas/BusinessPartnerRelationTypeTechnicalKey","kind":"json-schema","title":"BusinessPartnerRelationTypeTechnicalKey","data":{"type":"string","description":"Technical Key of the Business Partner Relation Type.","example":"COMMERCIAL_ULTIMATE"}},"components/schemas/BusinessPartnerRelationClassName":{"id":"components/schemas/BusinessPartnerRelationClassName","kind":"json-schema","title":"BusinessPartnerRelationClassName","data":{"type":"string","description":"Display name of the Business Partner Relation Class.","example":"CDQ Hierarchy"}},"components/schemas/BusinessPartnerRelationClassUrl":{"id":"components/schemas/BusinessPartnerRelationClassUrl","kind":"json-schema","title":"BusinessPartnerRelationClassUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of a business partner relation class.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/BusinessPartnerRelationClassTechnicalKey":{"id":"components/schemas/BusinessPartnerRelationClassTechnicalKey","kind":"json-schema","title":"BusinessPartnerRelationClassTechnicalKey","data":{"type":"string","description":"Technical Key of the Business Partner Relation Class.","example":"BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"}},"components/schemas/BusinessPartnerRelationStartNode":{"id":"components/schemas/BusinessPartnerRelationStartNode","kind":"json-schema","title":"BusinessPartnerRelationStartNode","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"FR.RC:5664645"}},"components/schemas/BusinessPartnerRelationEndNode":{"id":"components/schemas/BusinessPartnerRelationEndNode","kind":"json-schema","title":"BusinessPartnerRelationEndNode","data":{"type":"string","description":"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"}},"components/schemas/InternationalBankAccountIdentifier":{"id":"components/schemas/InternationalBankAccountIdentifier","kind":"json-schema","title":"InternationalBankAccountIdentifier","data":{"type":"string","description":"The IBAN of a bank account.","example":"CH8800781619278412000"}},"components/schemas/InternationalBankIdentifier":{"id":"components/schemas/InternationalBankIdentifier","kind":"json-schema","title":"InternationalBankIdentifier","data":{"type":"string","description":"(BIC/SWIFT) Bank identifier which is globally unique.","example":"KBSGCH22XXX"}},"components/schemas/NationalBankAccountIdentifier":{"id":"components/schemas/NationalBankAccountIdentifier","kind":"json-schema","title":"NationalBankAccountIdentifier","data":{"type":"string","description":"Identifier of a bank account in a national context, i.e. for a country.","example":"619278412000"}},"components/schemas/NationalBankIdentifier":{"id":"components/schemas/NationalBankIdentifier","kind":"json-schema","title":"NationalBankIdentifier","data":{"type":"string","description":"Bank identifier which is unique in a national context, i.e. for a country.","example":"00781"}},"components/schemas/BankName":{"id":"components/schemas/BankName","kind":"json-schema","title":"BankName","data":{"description":"The name of a bank.","type":"string","example":"Sparda Bank"}},"components/schemas/BankBranch":{"id":"components/schemas/BankBranch","kind":"json-schema","title":"BankBranch","data":{"description":"The branch of a bank.","type":"string","example":"Filiale München"}},"components/schemas/BankAccountCountryCode":{"id":"components/schemas/BankAccountCountryCode","kind":"json-schema","title":"BankAccountCountryCode","data":{"type":"string","description":"ISO code to identify the country a bank account is registered in.","example":"DE"}},"components/schemas/BusinessPartnerTypeName":{"id":"components/schemas/BusinessPartnerTypeName","kind":"json-schema","title":"BusinessPartnerTypeName","data":{"type":"string","description":"Display name of the Business Partner Type Name.","example":"Legal Entity"}},"components/schemas/BusinessPartnerTypeUrl":{"id":"components/schemas/BusinessPartnerTypeUrl","kind":"json-schema","title":"BusinessPartnerTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of a business partner type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/BusinessPartnerTypeTechnicalKey":{"id":"components/schemas/BusinessPartnerTypeTechnicalKey","kind":"json-schema","title":"BusinessPartnerTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Business Partner Type.","example":"LEGAL_ENTITY"}},"components/schemas/ExternalContextIdentifierValue":{"id":"components/schemas/ExternalContextIdentifierValue","kind":"json-schema","title":"ExternalContextIdentifierValue","data":{"type":"string","description":"Value of own identifiers of a record.","example":"7250017031"}},"components/schemas/ExternalContextIdentifierTypeTechnicalKey":{"id":"components/schemas/ExternalContextIdentifierTypeTechnicalKey","kind":"json-schema","title":"ExternalContextIdentifierTypeTechnicalKey","data":{"type":"string","description":"Technical key for the External Context Identifier Type.","example":"KUNNR"}},"components/schemas/ExternalContextIdentifierType":{"id":"components/schemas/ExternalContextIdentifierType","kind":"json-schema","title":"ExternalContextIdentifierType","data":{"type":"object","description":"Type of own identifiers of a record.","properties":{"technicalKey":{"$ref":"#/components/schemas/ExternalContextIdentifierTypeTechnicalKey"}}}},"components/schemas/BusinessPartnerId":{"id":"components/schemas/BusinessPartnerId","kind":"json-schema","title":"BusinessPartnerId","data":{"type":"string","description":"Technical identifier of a business partner record, unique within the CDQ.","example":"63e635235c06b7396330fe40"}},"components/schemas/ModifiedAt":{"id":"components/schemas/ModifiedAt","kind":"json-schema","title":"ModifiedAt","data":{"type":"string","description":"Date of modification (ISO 8601-compliant).","example":"2026-11-10T13:37:16Z"}},"components/schemas/ApiErrorTimestamp":{"id":"components/schemas/ApiErrorTimestamp","kind":"json-schema","title":"ApiErrorTimestamp","data":{"type":"string","deprecated":true,"description":"ISO 8601 representation of the timestamp.","example":"2026-11-10T13:37:16Z"}},"components/schemas/ApiErrorMessage":{"id":"components/schemas/ApiErrorMessage","kind":"json-schema","title":"ApiErrorMessage","data":{"type":"string","deprecated":true,"description":"Details about the error.","example":"This user is not allowed to access this service."}},"components/schemas/HttpError":{"id":"components/schemas/HttpError","kind":"json-schema","title":"HttpError","data":{"type":"string","description":"RFC 7231 error which belongs to the status code.","example":"BAD_REQUEST","deprecated":true}},"components/schemas/HttpPath":{"id":"components/schemas/HttpPath","kind":"json-schema","title":"HttpPath","data":{"type":"string","description":"Requested path which caused this error.","example":"/v2/businesspartners/lookup"}},"components/schemas/HttpStatus":{"id":"components/schemas/HttpStatus","kind":"json-schema","title":"HttpStatus","data":{"type":"integer","description":"RFC 7231 status code for this error.","example":"400","deprecated":true}},"components/schemas/StartAfter":{"id":"components/schemas/StartAfter","kind":"json-schema","title":"StartAfter","data":{"type":"string","description":"The ID which is used to read the page.","example":"5712566172571652"}},"components/schemas/Limit":{"id":"components/schemas/Limit","kind":"json-schema","title":"Limit","data":{"type":"integer","description":"Number of items per page.","example":"100"}},"components/schemas/PageTotal":{"id":"components/schemas/PageTotal","kind":"json-schema","title":"PageTotal","data":{"description":"Total number of items which can be paged.","example":"67","type":"integer"}},"components/schemas/NextStartAfter":{"id":"components/schemas/NextStartAfter","kind":"json-schema","title":"NextStartAfter","data":{"type":"string","description":"Provides a value to be used as a startAfter in next page request.","example":"5712566172571652"}},"components/schemas/ReplyQueue":{"id":"components/schemas/ReplyQueue","kind":"json-schema","title":"ReplyQueue","data":{"type":"string","description":"Technical descriptor of reply queue where workers should put back the result.","example":"647328648329632-34890742-3432"}},"components/schemas/BusinessRuleResult":{"id":"components/schemas/BusinessRuleResult","kind":"json-schema","title":"BusinessRuleResult","data":{"type":"string","description":"Contains information, if available, about the data returned from execution of business rule.","example":"parentConceptIdSelector = 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJleGFtcGxlLXVzZXIiLCJpc3MiOiJodHRwczovL2V4YW1wbGUuY29tIiwiaWF0IjoxNTE2MjM5MDIyfQ.EXAMPLE_SIGNATURE_PLACEHOLDER', content = '1633582012931231', parentConceptUrl='https://meta.cdq.com/Public:CDQ_data_model', recordId = '451ff2f9-8182-43fc-9728-aad9ce62d771', contentSelector = 'businessPartner.identifiers.value', contentSelectorUrl = 'https://meta.cdq.com/Public:CDQ_data_model', parentConceptId = 'EE_BRN'"}},"components/schemas/ReportBuildToggle":{"id":"components/schemas/ReportBuildToggle","kind":"json-schema","title":"ReportBuildToggle","data":{"type":"boolean","description":"Enable to generate this report.","example":"true"}},"components/schemas/AddressReportConfiguration":{"id":"components/schemas/AddressReportConfiguration","kind":"json-schema","title":"AddressReportConfiguration","data":{"type":"object","description":"Configures if and how Address reports are generated.","properties":{"build":{"$ref":"#/components/schemas/ReportBuildToggle"}}}},"components/schemas/BusinessPartnerReportConfiguration":{"id":"components/schemas/BusinessPartnerReportConfiguration","kind":"json-schema","title":"BusinessPartnerReportConfiguration","data":{"type":"object","description":"Configures if and how Business Partner reports are generated.","properties":{"build":{"$ref":"#/components/schemas/ReportBuildToggle"}}}},"components/schemas/IdentifierReportConfiguration":{"id":"components/schemas/IdentifierReportConfiguration","kind":"json-schema","title":"IdentifierReportConfiguration","data":{"type":"object","description":"Configures if and how Identifier reports are generated.","properties":{"build":{"$ref":"#/components/schemas/ReportBuildToggle"}}}},"components/schemas/OverallReportConfiguration":{"id":"components/schemas/OverallReportConfiguration","kind":"json-schema","title":"OverallReportConfiguration","data":{"type":"object","description":"Configures if and how Overall reports are generated.","properties":{"build":{"$ref":"#/components/schemas/ReportBuildToggle"}}}},"components/schemas/QualificationReportConfiguration":{"id":"components/schemas/QualificationReportConfiguration","kind":"json-schema","title":"QualificationReportConfiguration","data":{"type":"object","description":"Configures if and how Qualification reports are generated.","properties":{"build":{"$ref":"#/components/schemas/ReportBuildToggle"}}}},"components/schemas/QualityImprovementReportConfiguration":{"id":"components/schemas/QualityImprovementReportConfiguration","kind":"json-schema","title":"QualityImprovementReportConfiguration","data":{"type":"object","description":"Configures if and how Quality Improvement reports are generated.","properties":{"build":{"$ref":"#/components/schemas/ReportBuildToggle"},"dataValidationJobIds":{"type":"array","description":"An array which contains Data Validation Job IDs.","example":["6be92567-4327-4463-813f-a8c990410d79","f9df6cd4-4414-4719-9fb5-4eb6e5bc04cb"],"items":{"$ref":"#/components/schemas/DataValidationJobId"}}}}},"components/schemas/schemas-CountryShortName":{"id":"components/schemas/schemas-CountryShortName","kind":"json-schema","title":"schemas-CountryShortName","data":{"type":"string","description":"Optional parameter to limit on specific country only.","example":"DE"}},"components/schemas/DataValidationReportsConfiguration":{"id":"components/schemas/DataValidationReportsConfiguration","kind":"json-schema","title":"DataValidationReportsConfiguration","data":{"type":"object","description":"Configures if and how Data Validation reports are generated.","properties":{"address":{"$ref":"#/components/schemas/AddressReportConfiguration"},"businesspartner":{"$ref":"#/components/schemas/BusinessPartnerReportConfiguration"},"identifier":{"$ref":"#/components/schemas/IdentifierReportConfiguration"},"overall":{"$ref":"#/components/schemas/OverallReportConfiguration"},"qualification":{"$ref":"#/components/schemas/QualificationReportConfiguration"},"qualityImprovement":{"$ref":"#/components/schemas/QualityImprovementReportConfiguration"},"countryShortNames":{"type":"array","items":{"$ref":"#/components/schemas/schemas-CountryShortName"},"description":"An array which contains country short names (ISO-2 Format).","example":"['PL', 'DE', 'CZ', 'SK']"}}}},"components/schemas/JobStatus":{"id":"components/schemas/JobStatus","kind":"json-schema","title":"JobStatus","data":{"type":"string","description":"Job execution status.","example":"RUNNING"}},"components/schemas/UserId":{"id":"components/schemas/UserId","kind":"json-schema","title":"UserId","data":{"type":"string","description":"Unique ID of a user.","example":"johndoe"}},"components/schemas/LookupJobId":{"id":"components/schemas/LookupJobId","kind":"json-schema","title":"LookupJobId","data":{"type":"string","description":"Job Id which was received from the \"Start Lookup Job\".","example":"cbed7ac6-a97d-4c23-9060-2a88fa660957"}},"components/schemas/ProcessingStatusTechnicalKeyEnum":{"id":"components/schemas/ProcessingStatusTechnicalKeyEnum","kind":"json-schema","title":"ProcessingStatusTechnicalKeyEnum","data":{"type":"string","description":"Possible technical states of processing.","enum":["READY","RETRY","BLOCKED","IN_PROGRESS"],"x-enumDescriptions":{"READY":"Processing Log Data processing has finished and result ready to consume.","RETRY":"Processing Log Data processing has failed and needs to be retried.","BLOCKED":"Processing Log Data processing is blocked and needs to be resolved.","IN_PROGRESS":"Processing Log Data is being processed."},"example":"IN_PROGRESS"}},"components/schemas/StorageDataSourceId":{"id":"components/schemas/StorageDataSourceId","kind":"json-schema","title":"StorageDataSourceId","data":{"type":"string","description":"Unique number of Data Source.","example":"5e2874fb8d2a7400011acee1"}},"components/schemas/ProcessingStatusTechnicalKey":{"id":"components/schemas/ProcessingStatusTechnicalKey","kind":"json-schema","title":"ProcessingStatusTechnicalKey","data":{"type":"string","description":"Possible technical states of processing.","example":"IN_PROGRESS"}},"components/schemas/WorkspaceId":{"id":"components/schemas/WorkspaceId","kind":"json-schema","title":"WorkspaceId","data":{"type":"string","description":"Uniquely identifying ID of the workspace.","example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"}},"components/schemas/ConfigurationName":{"id":"components/schemas/ConfigurationName","kind":"json-schema","title":"ConfigurationName","data":{"type":"string","description":"Display name for a configuration.","example":"Client configuration."}},"components/schemas/schemas-ConfigurationId":{"id":"components/schemas/schemas-ConfigurationId","kind":"json-schema","title":"schemas-ConfigurationId","data":{"type":"string","description":"Uniquely identifies a configuration.","example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"}},"components/schemas/CreatedBy":{"id":"components/schemas/CreatedBy","kind":"json-schema","title":"CreatedBy","data":{"type":"string","description":"Creator of a resource.","example":"76248934691294444"}},"components/schemas/schemas-ValidationProfile":{"id":"components/schemas/schemas-ValidationProfile","kind":"json-schema","title":"schemas-ValidationProfile","data":{"type":"string","description":"A validation profile is a predefined setup of the validation for a particular use case.","example":"QUICK"}},"components/schemas/schemas-ValidationFeature":{"id":"components/schemas/schemas-ValidationFeature","kind":"json-schema","title":"schemas-ValidationFeature","data":{"type":"string","description":"When enabled will trigger rules of related categories to execute.","example":"BUSINESS_PARTNER_CHECKS"}},"components/schemas/ValidationRuleCategoryUrl":{"id":"components/schemas/ValidationRuleCategoryUrl","kind":"json-schema","title":"ValidationRuleCategoryUrl","data":{"type":"string","description":"Used to filter rule by its URL.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/HttpStatusCode":{"id":"components/schemas/HttpStatusCode","kind":"json-schema","title":"HttpStatusCode","data":{"type":"integer","description":"RFC 7231 status code for this error.","example":"200"}},"components/schemas/HttpStatusTechnicalKey":{"id":"components/schemas/HttpStatusTechnicalKey","kind":"json-schema","title":"HttpStatusTechnicalKey","data":{"type":"string","description":"Technical key describing the status or error","example":"OK"}},"components/schemas/StatusDetailsMessageId":{"id":"components/schemas/StatusDetailsMessageId","kind":"json-schema","title":"StatusDetailsMessageId","data":{"type":"integer","description":"9-digit code which is uniquely identifying a message","example":200000004}},"components/schemas/StatusDetailsMessage":{"id":"components/schemas/StatusDetailsMessage","kind":"json-schema","title":"StatusDetailsMessage","data":{"type":"string","description":"Human-readable message which may also be presented in user interface.","example":"The job came to an end and finished successfully."}},"components/schemas/StatusDetailsTechnicalKey":{"id":"components/schemas/StatusDetailsTechnicalKey","kind":"json-schema","title":"StatusDetailsTechnicalKey","data":{"type":"string","description":"Technical key to uniquely identify a message.","example":"JOB_FINISHED"}},"components/schemas/JsonPath":{"id":"components/schemas/JsonPath","kind":"json-schema","title":"JsonPath","data":{"type":"string","description":"JSONPath as specified by the IETF standard","example":"$.businessPartner.names[0].value"}},"components/schemas/JsonObject":{"id":"components/schemas/JsonObject","kind":"json-schema","title":"JsonObject","data":{"type":"string","description":"Object provided in plain JSON format.","example":"{ \"key\" : \"value\"}","additionalProperties":true}},"components/schemas/StatusDetails":{"id":"components/schemas/StatusDetails","kind":"json-schema","title":"StatusDetails","data":{"type":"object","description":"Details about this status or error","required":["id","message"],"properties":{"id":{"$ref":"#/components/schemas/StatusDetailsMessageId"},"message":{"$ref":"#/components/schemas/StatusDetailsMessage"},"technicalKey":{"$ref":"#/components/schemas/StatusDetailsTechnicalKey"},"jsonPath":{"$ref":"#/components/schemas/JsonPath"},"jsonRecord":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/StatusTimestamp":{"id":"components/schemas/StatusTimestamp","kind":"json-schema","title":"StatusTimestamp","data":{"type":"string","description":"ISO 8601 representation of the timestamp.","example":"2026-11-10T13:37:16Z"}},"components/schemas/BusinessPartnerQualificationRequestProfile":{"id":"components/schemas/BusinessPartnerQualificationRequestProfile","kind":"json-schema","title":"BusinessPartnerQualificationRequestProfile","data":{"type":"string","description":"Profile used in the qualification process.","example":"EU_TAX_QUALIFICATION"}},"components/schemas/BusinessPartnerOperationalStatus":{"id":"components/schemas/BusinessPartnerOperationalStatus","kind":"json-schema","title":"BusinessPartnerOperationalStatus","data":{"type":"object","description":"Represents the operational status of the business partner.","properties":{"type":{"type":"object","description":"Describes the type of business partner status.","properties":{"name":{"type":"string","description":"Name of the business partner status.","example":"Active"},"url":{"type":"string","description":"URL linking to more information about the business partner status.","example":"N/A"},"technicalKey":{"type":"string","description":"Technical key associated with the business partner status.","example":"ACTIVE"}}}}}},"components/schemas/QualificationRequestIdentifier":{"id":"components/schemas/QualificationRequestIdentifier","kind":"json-schema","title":"QualificationRequestIdentifier","data":{"type":"object","description":"Request identifier used for the qualification process.","properties":{"dataSourceTechnicalKey":{"$ref":"#/components/schemas/ProvenanceTechnicalKey"},"value":{"type":"string","description":"Value of the datasource technical key.","example":"WAPIAAAAYhCi7BOK"}}}},"components/schemas/schemas-QualificationDecision":{"id":"components/schemas/schemas-QualificationDecision","kind":"json-schema","title":"schemas-QualificationDecision","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Qualification process result decision."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Qualification completed and the result is valid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Qualification completed, and the result is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_PROCESSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": There is no rule for qualifying this particular target, a rule was deactivated, or we are not able to process this particular data field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_INPUT_PROVIDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The qualification process could not be started because the input data is not complete."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_REFERENCE_PROVIDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The qualification process could not be concluded because no reference data was obtained."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTION_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Server error prevented qualification from reaching a conclusion."},"children":[]}]}]}]}],"example":"VALID"}},"components/schemas/AddressQualificationDecisionDetails":{"id":"components/schemas/AddressQualificationDecisionDetails","kind":"json-schema","title":"AddressQualificationDecisionDetails","data":{"type":"object","description":"Represents the details of a qualification decision for an address.","properties":{"localityQualificationDecision":{"$ref":"#/components/schemas/schemas-QualificationDecision"},"postCodeQualificationDecision":{"$ref":"#/components/schemas/schemas-QualificationDecision"},"thoroughfareQualificationDecision":{"$ref":"#/components/schemas/schemas-QualificationDecision"}}}},"components/schemas/QualificationDecisionSummary":{"id":"components/schemas/QualificationDecisionSummary","kind":"json-schema","title":"QualificationDecisionSummary","data":{"type":"object","description":"Provides a concise summary of a qualification decision.","properties":{"identifierQualificationDecision":{"$ref":"#/components/schemas/schemas-QualificationDecision"},"nameQualificationDecision":{"$ref":"#/components/schemas/schemas-QualificationDecision"},"addressQualificationDecision":{"$ref":"#/components/schemas/schemas-QualificationDecision"},"addressQualificationDecisionDetails":{"$ref":"#/components/schemas/AddressQualificationDecisionDetails"},"overallQualificationDecision":{"$ref":"#/components/schemas/schemas-QualificationDecision"}}}},"components/schemas/DetailsBusinessRule":{"id":"components/schemas/DetailsBusinessRule","kind":"json-schema","title":"DetailsBusinessRule","data":{"type":"object","description":"Represents a Business Rule.","allOf":[{"$ref":"#/components/schemas/BusinessRule"},{"type":"object","description":"Business rule that was executed.","properties":{"violationMessage":{"type":"string","description":"Violation message that is returned with detected data defect.","example":"Business Partner identifier is mandatory."}}}]}},"components/schemas/ExecutionContextProperty":{"id":"components/schemas/ExecutionContextProperty","kind":"json-schema","title":"ExecutionContextProperty","data":{"type":"object","description":"Represents an execution context property.","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descriptive name of the context’s attribute."},"children":[]}]}]}],"example":"qualificationTarget"},"value":{"type":"string","description":"Value of the context execution attribute.","example":"STREET"}}}},"components/schemas/QualificationDecisionDetails":{"id":"components/schemas/QualificationDecisionDetails","kind":"json-schema","title":"QualificationDecisionDetails","data":{"type":"object","description":"Represents the details of a qualification decision.","properties":{"businessRule":{"$ref":"#/components/schemas/DetailsBusinessRule"},"executionContextProperties":{"type":"array","description":"List of Execution Context Properties.","items":{"$ref":"#/components/schemas/ExecutionContextProperty"}},"cdqId":{"$ref":"#/components/schemas/ProvenanceCdqId"},"decision":{"$ref":"#/components/schemas/schemas-QualificationDecision"},"error":{"$ref":"#/components/schemas/ApiError"}}}},"components/schemas/BusinessPartnerQualificationResultItem":{"id":"components/schemas/BusinessPartnerQualificationResultItem","kind":"json-schema","title":"BusinessPartnerQualificationResultItem","data":{"type":"object","description":"Represents an item in the result of a Business Partner qualification.","properties":{"identifier":{"$ref":"#/components/schemas/IdentifierParam"},"businessPartnerStatus":{"$ref":"#/components/schemas/BusinessPartnerOperationalStatus"},"qualifiedAt":{"type":"string","description":"Date and time of qualification.","example":"2026-11-10T13:37:16Z"},"dataSourceTechnicalKey":{"type":"string","description":"Data source used for qualification.","example":"VIES"},"dataSourceRequestIdentifiers":{"type":"array","description":"List of Request Identifiers.","items":{"$ref":"#/components/schemas/QualificationRequestIdentifier"}},"qualificationDecisionSummary":{"$ref":"#/components/schemas/QualificationDecisionSummary"},"qualificationDecisionDetails":{"type":"array","description":"List of Qualification Decision Details.","items":{"$ref":"#/components/schemas/QualificationDecisionDetails"}}}}},"components/schemas/CorrelationId":{"id":"components/schemas/CorrelationId","kind":"json-schema","title":"CorrelationId","data":{"type":"string","description":"ID which uniquely chains a set of request()s and or task(s).","example":"123e4567-e89b-12d3-a456-426614174000"}},"components/schemas/Task":{"id":"components/schemas/Task","kind":"json-schema","title":"Task","data":{"type":"object","description":"A task is a unit of work.","properties":{"correlationId":{"$ref":"#/components/schemas/CorrelationId"},"userId":{"$ref":"#/components/schemas/UserId"},"jobId":{"$ref":"#/components/schemas/JobId"}}}},"components/schemas/Worker":{"id":"components/schemas/Worker","kind":"json-schema","title":"Worker","data":{"type":"string","description":"Worker which generated the result.","example":"pod-647328648329632-34890742-3432"}},"components/schemas/TaskStatus":{"id":"components/schemas/TaskStatus","kind":"json-schema","title":"TaskStatus","data":{"type":"string","description":"Task status.","example":"OK"}},"components/schemas/TaskMessage":{"id":"components/schemas/TaskMessage","kind":"json-schema","title":"TaskMessage","data":{"type":"string","description":"Details task status.","example":"The validation was successful."}},"components/schemas/TaskResult":{"id":"components/schemas/TaskResult","kind":"json-schema","title":"TaskResult","data":{"type":"object","description":"Result or outcome of a task.","properties":{"worker":{"$ref":"#/components/schemas/Worker"},"correlationId":{"$ref":"#/components/schemas/CorrelationId"},"status":{"$ref":"#/components/schemas/TaskStatus"},"message":{"$ref":"#/components/schemas/TaskMessage"}}}},"schema_0":{"kind":"json-schema","data":{"type":"string","example":"6be92567-4327-4463-813f-a8c990410d79"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"array","description":"List of Record IDs.","items":{"type":"string","description":"Record ID.","example":"6be92567-4327-4463-813f-a8c990410d79"}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"$ref":"#/components/schemas/StartAfter"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Limit","minimum":1,"maximum":100,"default":100},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"$ref":"#/components/schemas/LookupJobId"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"array","description":"List of Business Partner IDs.","items":{"$ref":"#/components/schemas/BusinessPartnerId"}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ValidationResultField"}},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DataValidationJobId"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ValidationProcessingLogIdParam"},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"array","description":"List of Business Partner IDs.","maxItems":500,"items":{"$ref":"#/components/schemas/BusinessPartnerId"}},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"array","description":"List of Business Partner external IDs.","maxItems":500,"items":{"$ref":"#/components/schemas/BusinessPartnerExternalId"}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ProcessingStatusTechnicalKeyEnum"},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Limit","minimum":1,"maximum":100,"default":100,"example":"100"},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"string","example":"2026-11-10T13:37:16Z"},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"array","description":"List of features to be deactivated.","items":{"$ref":"#/components/schemas/ValidationLogResultsReadFeatureEnum"}},"id":"schema_16"},"schema_19":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Limit"},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DefaultWorkspaceConfiguration"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"string","description":"API Key ID or Client ID. When present returns only configurations assigned to the given API key.","example":"12345678-1234-5678-1234-567812345678"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"string","example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"},"id":"schema_22"},"schema_24":{"kind":"json-schema","data":{"type":"array","description":"List of features to be enabled.","items":{"$ref":"#/components/schemas/TransactionFeatureParam"}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"integer","example":1},"id":"schema_25"}},"exampleStore":{"paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/example":{"value":{"storageId":"YOUR_STORAGE_ID","profile":"EU_VAT_QUALIFICATION","featuresOn":["SHOW_LOOKUP_RESULTS"],"featuresOff":["SHOW_LOOKUP_RESULTS"],"ruleStatuses":["RELEASED"],"vatAtRequestor":"AT123456789","vatDeRequestor":"DE123456789","bzstPrint":true,"validationSource":"BZST","reportsRequest":{"reportsConfiguration":{"address":{"build":false},"businesspartner":{"build":false},"identifier":{"build":false},"overall":{"build":false},"qualification":{"build":true},"qualityImprovement":{"build":false,"dataValidationJobIds":["6be92567-4327-4463-813f-a8c990410d79","f9df6cd4-4414-4719-9fb5-4eb6e5bc04cb"]},"countryShortNames":"['PL', 'DE', 'CZ', 'SK']"}},"dataSourcesOn":[{"prefix":"string"}],"dataSourcesOff":[{"prefix":"string"}],"ruleCategoriesOn":[{"url":"string","name":"string"}],"ignoredRules":["string"],"activatedRules":["string"],"updatedFrom":"2020-07-06T12:14:03.204Z","dataSourceIds":["string"],"countryShortNames":["string"],"configurationId":"string","criticalities":[{"businessRuleUrl":"string","violationLevel":"NO_DEFECT"}]},"key":"example","summary":"Full example","id":"paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/example"},"paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/tutorial":{"value":{"storageId":"YOUR_STORAGE_ID","profile":"EU_VAT_QUALIFICATION","featuresOn":["SHOW_LOOKUP_RESULTS"]},"key":"tutorial","summary":"Run UE VAT Qualification Job","id":"paths/~1v2~1businesspartnervalidationjobs/post/requestBody/content/application~1json/examples/tutorial"},"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongUid":{"value":{"businessPartner":{"names":[{"value":"CDQ AG"}],"identifiers":[{"value":"218.608.886","type":{"technicalKey":"CH_UID"}}],"legalForm":{"name":"Aktiengesellschaft"},"addresses":[{"country":{"shortName":"CH"},"thoroughfares":[{"value":"Lukasstrassse 4"}],"localities":[{"value":"St.Gallen"}],"postCodes":[{"value":"9008"}]}]}},"key":"wrongUid","summary":"Recognize wrong UID from CDQ AG","id":"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongUid"},"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongCNPJ":{"value":{"businessPartner":{"names":[{"value":"BASF SA"}],"identifiers":[{"type":{"technicalKey":"BR_CNPJ"},"value":"48.539.407/00718-01"}],"legalForm":{"name":"Anonymous Society"},"addresses":[{"country":{"shortname":"BR"},"postCodes":[{"value":"42810-020"}],"localities":[{"value":"Camaçari"}]}]}},"key":"wrongCNPJ","summary":"Recognize wrong  CNPJ from BASF SA","id":"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/wrongCNPJ"},"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateSelectedRules":{"value":{"profile":"STANDARD","featuresOn":["SHOW_DEBUG_INFO","SHOW_BUSINESSPARTNER"],"activatedRules":["https://meta.cdq.com/Identifier_format_invalid_(NIP_number_(Poland))","https://meta.cdq.com/Mandatory_administrative_area_missing_(Poland)"],"businessPartner":{"identifiers":[{"value":"89927909651","type":{"technicalKey":"PL_NIP"}}],"addresses":[{"country":{"shortName":"PL"}}]}},"key":"activateSelectedRules","summary":"Activate selected rules by providing list of rule URLs. Expected result: Only results from selected rules are present.\n","id":"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateSelectedRules"},"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateNewQualificationMode":{"value":{"profile":"EU_VAT_QUALIFICATION","businessPartner":{"names":[{"value":"CDQ GmbH"}],"addresses":[{"country":{"shortName":"DE"},"localities":[{"value":"Friedrichshafen"}],"postCodes":[{"value":"88045"}],"thoroughfares":[{"value":"Albrechtstraße  8"}]}],"identifiers":[{"value":"DE307699628","type":{"technicalKey":"EU_VAT_ID_DE"},"issuingBody":{"name":"Federal Ministry of Finance, Bundesfinanzministerium"}}]},"featuresOn":["EU_VAT_QUALIFICATION_AT","SHOW_DEBUG_INFO","SHOW_BUSINESSPARTNER","SHOW_LOOKUP_RESULTS"]},"key":"activateNewQualificationMode","summary":"Activate qualification for German business partners via EU_VAT_QUALIFICATION profile and EU_VAT_QUALIFICATION_AT feature. Expected result: Qualification in identifierResults section.\n","id":"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/activateNewQualificationMode"},"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/oldQualification":{"value":{"profile":"EU_VAT_QUALIFICATION","businessPartner":{"identifiers":[{"value":"FR09572067684","type":{"technicalKey":"EU_VAT_ID_FR"}}],"addresses":[{"country":{"shortName":"FR"},"thoroughfares":[{"value":"Hardtstr. 12"}],"postCodes":[{"value":"70839"}],"localities":[{"value":"Gerlingen"}]}]}},"key":"oldQualification","summary":"Activate qualification via EU_VAT_QUALIFICATION profile. Expected result: Qualification in identifierResults section.\n","id":"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/oldQualification"},"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierExistsAndIsValid":{"value":{"profile":"IDENTIFIER_QUALITY","businessPartner":{"addresses":[{"country":{"shortName":"DE"}}],"identifiers":[{"type":{"technicalKey":"EU_VAT_ID_DE"},"value":"DE307699628"}]}},"key":"identifierExistsAndIsValid","summary":"Identifier exists and is valid","id":"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierExistsAndIsValid"},"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierDoesNotExistInExternalDataSource":{"value":{"profile":"IDENTIFIER_QUALITY","businessPartner":{"addresses":[{"country":{"shortName":"DE"}}],"identifiers":[{"type":{"technicalKey":"EU_VAT_ID_DE"},"value":"DE119267630"}]}},"key":"identifierDoesNotExistInExternalDataSource","summary":"Identifier does not exist in external data source","id":"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/identifierDoesNotExistInExternalDataSource"},"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/quotaLimitExceeded":{"value":{"businessPartner":{"identifiers":[{"value":"781-18-18-991","type":{"technicalKey":"PL_NIP"}}]},"featuresOn":["FORCE_EXTERNAL_CALL","SHOW_LOOKUP_RESULTS","SHOW_DEBUG_INFO"]},"key":"quotaLimitExceeded","summary":"Quota limit exceeded for external data source","id":"paths/~1v2~1businesspartners~1validate/post/requestBody/content/application~1json/examples/quotaLimitExceeded"},"paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/identifierExistsAndIsValid":{"value":{"summary":{"validationLevel":"OK","action":"AUTO_APPROVE","statistics":{"numberOfInfoDataDefects":0,"numberOfErrorDataDefects":0,"numberOfWarningDataDefects":0}},"debugInfo":{"businessRulesExecutionSummary":{"numberOfRules":398,"numberOfExecutions":398,"numberOfFails":0,"ruleCategoriesOn":[{"url":"https://meta.cdq.com/Identifier_checkdigit"},{"url":"https://meta.cdq.com/Country_invalid"},{"url":"https://meta.cdq.com/Identifier_consistency"},{"url":"https://meta.cdq.com/Identifier_missing"},{"url":"https://meta.cdq.com/Identifier_format"},{"url":"https://meta.cdq.com/Identifier_deprecation"},{"url":"https://meta.cdq.com/Identifier_existence"},{"url":"https://meta.cdq.com/Identifier_schema"}],"violationLevels":["INFO","WARNING","ERROR"]}},"identifierResults":[{"property":{"value":"DE307699628","type":"EU_VAT_ID_DE"},"reliabilityLevel":{"name":"Identifier existence","url":"https://meta.cdq.com/Identifier_existence","value":4,"checks":[{"name":"Identifier checkdigit","url":"https://meta.cdq.com/Identifier_checkdigit","value":3,"status":"OK"},{"name":"Identifier existence","url":"https://meta.cdq.com/Identifier_existence","value":4,"status":"OK"},{"name":"Identifier format","url":"https://meta.cdq.com/Identifier_format","value":2,"status":"OK"}]}}],"businessPartner":{"legalForm":{},"identifiers":[{"value":"DE307699628","type":{"technicalKey":"EU_VAT_ID_DE"},"issuingBody":{}}],"addresses":[{"version":{"characterSet":{},"language":{}},"country":{"shortName":"DE","value":"Germany"}}],"profile":{}}},"key":"identifierExistsAndIsValid","summary":"Identifier exists and is valid","id":"paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/identifierExistsAndIsValid"},"paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/identifierDoesNotExistInExternalDataSource":{"value":{"dataDefects":[{"violationLevel\"":"ERROR"}],"identifierReliability":{"level":3}},"key":"identifierDoesNotExistInExternalDataSource","summary":"Identifier does not exist in external data source","id":"paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/identifierDoesNotExistInExternalDataSource"},"paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/unknownValidityForAnIdentifier":{"value":{"summary":{"validationLevel":"OK","action":"AUTO_APPROVE","statistics":{"numberOfInfoDataDefects":0,"numberOfErrorDataDefects":0,"numberOfWarningDataDefects":0}},"debugInfo":{"businessRulesExecutionSummary":{"numberOfRules":398,"numberOfExecutions":397,"numberOfFails":1,"ruleCategoriesOn":[{"url":"https://meta.cdq.com/Identifier_checkdigit"},{"url":"https://meta.cdq.com/Country_invalid"},{"url":"https://meta.cdq.com/Identifier_consistency"},{"url":"https://meta.cdq.com/Identifier_missing"},{"url":"https://meta.cdq.com/Identifier_format"},{"url":"https://meta.cdq.com/Identifier_deprecation"},{"url":"https://meta.cdq.com/Identifier_existence"},{"url":"https://meta.cdq.com/Identifier_schema"}],"violationLevels":["INFO","WARNING","ERROR"]}},"identifierResults":[{"property":{"value":"DE119267630","type":"EU_VAT_ID_DE"},"reliabilityLevel":{"name":"Identifier checkdigit","url":"https://meta.cdq.com/Identifier_checkdigit","value":3,"checks":[{"name":"Identifier checkdigit","url":"https://meta.cdq.com/Identifier_checkdigit","value":3,"status":"OK"},{"name":"Identifier existence","url":"https://meta.cdq.com/Identifier_existence","value":4,"status":"FAILED","message":"external service error"},{"name":"Identifier format","url":"https://meta.cdq.com/Identifier_format","value":2,"status":"OK"}]}}],"businessPartner":{"legalForm":{},"identifiers":[{"value":"DE119267630","type":{"technicalKey":"EU_VAT_ID_DE"},"issuingBody":{}}],"addresses":[{"version":{"characterSet":{},"language":{}},"country":{"shortName":"DE","value":"Germany"}}],"profile":{}}},"key":"unknownValidityForAnIdentifier","summary":"Unknown validity for an identifier existence","id":"paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/unknownValidityForAnIdentifier"},"paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/quotaLimitExceeded":{"value":{"dataDefects":[{"properties":[{"url":"https://meta.cdq.com/Business_partner/identifier/value","parentConcept":{"idSelector":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJleGFtcGxlLXVzZXIiLCJpc3MiOiJodHRwczovL2V4YW1wbGUuY29tIiwiaWF0IjoxNTE2MjM5MDIyfQ.EXAMPLE_SIGNATURE_PLACEHOLDER","url":"https://meta.cdq.com/Business_partner/identifier"}}],"validationSource":"CDL","businessRule":{"name":"Identifier missing (D-U-N-S (World))","url":"https://meta.cdq.com/Identifier_missing_(D-U-N-S_(World))","ruleStatus":"RELEASED"},"violationLevel":"INFO","violationMessage":"Business partner misses an optional D-U-N-S number.","categories":[{"url":"https://meta.cdq.com/Identifier_missing","name":"Identifier missing"}],"errorCode":0},{"properties":[{"url":"https://meta.cdq.com/Business_partner/legalForm","parentConcept":{"idSelector":"businessPartner","url":"https://meta.cdq.com/Business_partner"}}],"validationSource":"CDL","businessRule":{"name":"Legal form missing","url":"https://meta.cdq.com/Legal_form_missing","ruleStatus":"RELEASED"},"violationLevel":"INFO","violationMessage":"In general, each business partner must have exactly one legal form. For example, a business partner can never be an Aktiengesellschaft and a Gesellschaft mit beschraenkter Haftung at the same time. However, business partners that are marked by a no legal form required category are valid also without a legal form value.","categories":[{"url":"https://meta.cdq.com/Missing_legal_form","name":"Missing legal form"}],"errorCode":0}],"summary":{"validationLevel":"UNKNOWN","dataQualityRecordStatus":{"name":"Unknown","description":"The data quality status is unknown for this record. Please check rulesInError field for the details.","technicalKey":"UNKNOWN"},"action":"FULL_CHECK","statistics":{"numberOfInfoDataDefects":2,"numberOfErrorDataDefects":0,"numberOfWarningDataDefects":0}},"debugInfo":{"externalServiceResponses":[{"status":500,"message":"There is no more quota left for this data source.","timestamp":"2026-01-27T11:50:07.290975861Z","additionalInformation":[{"key":"rawJson","value":"[]"}]}],"businessRulesExecutionSummary":{"numberOfRules":2021,"numberOfExecutions":2020,"numberOfFails":0,"ruleCategoriesOn":[{"url":"https://meta.cdq.com/Postal_code_format"},{"url":"https://meta.cdq.com/Missing_legal_form"},{"url":"https://meta.cdq.com/Identifier_deprecated"},{"url":"https://meta.cdq.com/Care_of_misplaced"},{"url":"https://meta.cdq.com/Postal_code_invalid"},{"url":"https://meta.cdq.com/Business_partner_inactive"},{"url":"https://meta.cdq.com/Identifier_consistency"},{"url":"https://meta.cdq.com/Identifier_format"},{"url":"https://meta.cdq.com/Dummy_postal_code"},{"url":"https://meta.cdq.com/Country_missing"},{"url":"https://meta.cdq.com/Postal_code_outdated"},{"url":"https://meta.cdq.com/Administrative_area_missing"},{"url":"https://meta.cdq.com/Thoroughfare_missing"},{"url":"https://meta.cdq.com/Name_pattern"},{"url":"https://meta.cdq.com/Identifier_checkdigit"},{"url":"https://meta.cdq.com/Phone_number_misplaced"},{"url":"https://meta.cdq.com/Country_invalid"},{"url":"https://meta.cdq.com/Identifier_missing"},{"url":"https://meta.cdq.com/Postal_code_schema"},{"url":"https://meta.cdq.com/Contact_misplaced"},{"url":"https://meta.cdq.com/PO_Box_misplaced"},{"url":"https://meta.cdq.com/Name_missing"},{"url":"https://meta.cdq.com/Country_existence"},{"url":"https://meta.cdq.com/Postal_code_missing"},{"url":"https://meta.cdq.com/Identifier_existence"},{"url":"https://meta.cdq.com/Missing_locality"},{"url":"https://meta.cdq.com/Identifier_schema"}],"violationLevels":["ERROR","INFO","WARNING"]}},"identifierResults":[{"property":{"value":"781-18-18-991","type":"PL_NIP"},"reliabilityLevel":{"name":"Identifier checkdigit","url":"https://meta.cdq.com/Identifier_checkdigit","value":3,"checks":[{"name":"Identifier checkdigit","url":"https://meta.cdq.com/Identifier_checkdigit","value":3,"status":"OK"},{"name":"Identifier format","url":"https://meta.cdq.com/Identifier_format","value":2,"status":"OK"},{"name":"Identifier existence","url":"https://meta.cdq.com/Identifier_existence","value":4,"status":"FAILED","message":"External service error. There is no more quota left for this data source."}]}}],"businessPartner":{"identifiers":[{"value":"781-18-18-991","type":{"technicalKey":"PL_NIP"}}],"addresses":[{}]},"rulesInError":[{"businessRule":{"name":"Identifier unknown (NIP number (Poland))","url":"https://meta.cdq.com/Identifier_unknown_(NIP_number_(Poland))","ruleStatus":"RELEASED"},"executionStatus":"500","error":{"message":"There is no more quota left for this data source."},"violationLevel":"ERROR","validationSource":"CDL"}]},"key":"quotaLimitExceeded","summary":"Quota limit exceeded for external data source","id":"paths/~1v2~1businesspartners~1validate/post/responses/200/content/application~1json/examples/quotaLimitExceeded"},"paths/~1configurations~1businesspartnervalidation/get/responses/200/content/application~1json/examples/fetchConfigurations":{"value":{"startAfter":"0","nextStartAfter":"1","total":2,"values":[{"name":"demo config","id":"63a1d4a07c855600fa769329","createdAt":"2022-12-20T15:28:32.684Z","modifiedAt":"2022-12-20T15:28:32.684Z","createdBy":"demo"},{"name":"demo config","id":"63a1d5a13b5faf2f613164c0","createdAt":"2022-12-20T15:32:49.579Z","modifiedAt":"2022-12-20T15:32:49.579Z","createdBy":"demo"}]},"key":"fetchConfigurations","summary":"Page of fetched configurations","id":"paths/~1configurations~1businesspartnervalidation/get/responses/200/content/application~1json/examples/fetchConfigurations"},"paths/~1configurations~1businesspartnervalidation/post/requestBody/content/application~1json/examples/createComplexConfiguration":{"value":{"name":"Demo config","configuration":{"validationProfile":"STANDARD","ruleStatuses":["HYPERCARE","RELEASED"],"featuresOn":["SHOW_DEBUG_INFO","ENRICH_LEGAL_FORM","ENRICH_CATEGORIES","SHOW_BUSINESSPARTNER","SHOW_DATA_DEFECTS","IDENTIFIER_CHECKS","BUSINESS_PARTNER_CHECKS","ADDRESS_CHECKS","COUNTRY_CHECKS"]}},"key":"createComplexConfiguration","summary":"Creating configuration","id":"paths/~1configurations~1businesspartnervalidation/post/requestBody/content/application~1json/examples/createComplexConfiguration"},"paths/~1configurations~1businesspartnervalidation/post/responses/200/content/application~1json/examples/createComplexConfiguration":{"value":{"name":"Demo config","configuration":{"validationProfile":"STANDARD","ruleStatuses":["HYPERCARE","RELEASED"],"featuresOn":["SHOW_DEBUG_INFO","ENRICH_LEGAL_FORM","ENRICH_CATEGORIES","SHOW_BUSINESSPARTNER","SHOW_DATA_DEFECTS","IDENTIFIER_CHECKS","BUSINESS_PARTNER_CHECKS","ADDRESS_CHECKS","COUNTRY_CHECKS"]},"version":1,"id":"693133f25145ab285033b0e8","createdAt":"2025-12-04T07:10:42.138388938Z","createdBy":"demo","defaultConfiguration":false,"relatedConfigurations":[]},"key":"createComplexConfiguration","summary":"Creating configuration","id":"paths/~1configurations~1businesspartnervalidation/post/responses/200/content/application~1json/examples/createComplexConfiguration"},"paths/~1configurations~1businesspartnervalidation~1{configurationId}/get/responses/200/content/application~1json/examples/getConfiguration":{"value":{"name":"Demo config","configuration":{"validationProfile":"STANDARD","ruleStatuses":["HYPERCARE","RELEASED"],"featuresOn":["SHOW_DEBUG_INFO","ENRICH_LEGAL_FORM","ENRICH_CATEGORIES","SHOW_BUSINESSPARTNER","SHOW_DATA_DEFECTS","IDENTIFIER_CHECKS","BUSINESS_PARTNER_CHECKS","ADDRESS_CHECKS","COUNTRY_CHECKS"]},"version":1,"id":"693133f25145ab285033b0e8","createdAt":"2025-12-04T07:10:42.138Z","createdBy":"demo","defaultConfiguration":false,"relatedConfigurations":[]},"key":"getConfiguration","summary":"Fetching configuration","id":"paths/~1configurations~1businesspartnervalidation~1{configurationId}/get/responses/200/content/application~1json/examples/getConfiguration"},"paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/clearConfigurationToDefaults":{"value":{"name":"demo config","configuration":{}},"key":"clearConfigurationToDefaults","summary":"Clear configuration","id":"paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/clearConfigurationToDefaults"},"paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/updateFeaturesOnList":{"value":{"name":"Demo config","configuration":{"validationProfile":"STANDARD","ruleStatuses":["HYPERCARE","RELEASED"],"featuresOn":["SHOW_DEBUG_INFO","ENRICH_LEGAL_FORM"]}},"key":"updateFeaturesOnList","summary":"Update featuresOn list in configuration","id":"paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/requestBody/content/application~1json/examples/updateFeaturesOnList"},"paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/responses/200/content/application~1json/examples/clearConfigurationToDefaults":{"value":{"name":"demo config","configuration":{"validationProfile":"STANDARD"},"id":"63a1d5a13b5faf2f613164c0","createdAt":"2022-12-20T15:32:49.579Z","modifiedAt":"2022-12-20T15:43:43.158949713Z","createdBy":"demo"},"key":"clearConfigurationToDefaults","summary":"Cleared configuration","id":"paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/responses/200/content/application~1json/examples/clearConfigurationToDefaults"},"paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/responses/200/content/application~1json/examples/updatedFeaturesOnList":{"value":{"name":"Demo config","configuration":{"validationProfile":"STANDARD","ruleStatuses":["HYPERCARE","RELEASED"],"featuresOn":["SHOW_DEBUG_INFO","ENRICH_LEGAL_FORM"]},"version":2,"id":"693133f25145ab285033b0e8","createdAt":"2025-12-04T07:10:42.138Z","modifiedAt":"2025-12-04T07:19:22.427016021Z","createdBy":"demo","defaultConfiguration":false,"relatedConfigurations":[]},"key":"updatedFeaturesOnList","summary":"Updated featuresOn list in configuration","id":"paths/~1configurations~1businesspartnervalidation~1{configurationId}/put/responses/200/content/application~1json/examples/updatedFeaturesOnList"},"paths/~1configurations~1businesspartnervalidation~1{configurationId}/delete/responses/200/content/application~1json/examples/successfulDeletion":{"value":{"name":"Demo config","configuration":{"validationProfile":"STANDARD","ruleStatuses":["HYPERCARE","RELEASED"],"featuresOn":["SHOW_DEBUG_INFO","ENRICH_LEGAL_FORM"]},"version":2,"id":"693133f25145ab285033b0e8","createdAt":"2025-12-04T07:10:42.138Z","modifiedAt":"2025-12-04T07:19:22.427Z","createdBy":"demo","defaultConfiguration":false,"relatedConfigurations":[]},"key":"successfulDeletion","summary":"Successful deleted configuration","id":"paths/~1configurations~1businesspartnervalidation~1{configurationId}/delete/responses/200/content/application~1json/examples/successfulDeletion"},"paths/~1configurations~1businesspartnervalidation~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/getConfigurationForVersion":{"value":{"id":"693135fa5145ab285033b0ec","name":"Demo config","configurationId":"693133f25145ab285033b0e8","version":2,"configuration":{"validationProfile":"STANDARD","ruleStatuses":["HYPERCARE","RELEASED"],"featuresOn":["SHOW_DEBUG_INFO","ENRICH_LEGAL_FORM"]},"createdAt":"2025-12-04T07:10:42.138Z","createdBy":"demo","modifiedAt":"2025-12-04T07:19:22.427Z","modifiedBy":"demo","defaultConfiguration":false},"key":"getConfigurationForVersion","summary":"Fetching configuration for specific version","id":"paths/~1configurations~1businesspartnervalidation~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/getConfigurationForVersion"},"paths/~1configurations~1qualification/get/responses/200/content/application~1json/examples/taxGuardConfigurations":{"value":{"startAfter":"0","nextStartAfter":"1","total":2,"values":[{"name":"Demo config","id":"6932b3b5ede51e24d3ed8857","createdAt":"2025-12-05T10:28:05.824Z","createdBy":"demo"},{"name":"Demo config 2","id":"692f122024e2b238cde2856c","createdAt":"2025-12-02T16:21:52.013Z","createdBy":"demo2"}]},"key":"taxGuardConfigurations","summary":"Page of fetched configurations","id":"paths/~1configurations~1qualification/get/responses/200/content/application~1json/examples/taxGuardConfigurations"},"paths/~1configurations~1qualification~1{configurationId}/get/responses/200/content/application~1json/examples/fetchingConfiguration":{"value":{"name":"Demo config","configuration":{"featuresOn":["SHOW_DEBUG_INFO"],"qualificationProfile":"EU_TAX_QUALIFICATION"},"version":1,"id":"6932b3b5ede51e24d3ed8857","createdAt":"2025-12-05T10:28:05.824Z","createdBy":"demo","defaultConfiguration":false},"key":"fetchingConfiguration","summary":"Fetching configuration","id":"paths/~1configurations~1qualification~1{configurationId}/get/responses/200/content/application~1json/examples/fetchingConfiguration"},"paths/~1configurations~1qualification~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/fetchingConfigurationForVersion":{"value":{"id":"6932b59cede51e24d3ed8865","name":"Demo config","configurationId":"6932b3b5ede51e24d3ed8857","version":2,"configuration":{"featuresOn":["SHOW_DEBUG_INFO"],"qualificationProfile":"WORLDWIDE_TAX_QUALIFICATION"},"createdAt":"2025-12-05T10:28:05.824Z","createdBy":"demo","modifiedAt":"2025-12-05T10:36:12.791Z","modifiedBy":"demo","defaultConfiguration":false},"key":"fetchingConfigurationForVersion","summary":"Fetching configuration for specific version","id":"paths/~1configurations~1qualification~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/fetchingConfigurationForVersion"}},"securitySchemeStore":{"apiKey":{"id":"apiKey","type":"apiKey","in":"header","paramName":"X-API-KEY"}},"servers":[{"url":"https://api.cdq.com/data-validation/rest","description":"Production"}],"specType":"openapi"},"options":{"hideDownloadButtons":false,"codeSamples":{"skipOptionalParameters":true,"languages":[{"lang":"curl","label":"cURL"},{"lang":"Java","label":"Java"},{"lang":"JavaScript","label":"JavaScript"},{"lang":"Python","label":"Python"},{"lang":"Node.js","label":"Node.js"}]},"feedback":{"type":"sentiment","settings":{"label":"Share the feedback!","submitText":"Thank you for sharing!","reasons":{"component":"checkbox","label":"Tell us more about your experience.","items":["Content covered the topic well.","The content has great examples.","The content is thoroughly detailed.","The content is easy to understand."]},"comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"}}},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/data-validation-api/@data-validation-api-v2/api-v2.json?download"},{"url":"/_bundle/apis/data-validation-api/@data-validation-api-v2/api-v2.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Data Validation API","description":"**Build version:** `v2-5.99.9`\n\nThis API provides services to validate businesspartners and identifiers"}},"baseSlug":"/apis/data-validation-api/data-validation-api-v2/api-v2","routesMapping":{}}