This API provides services used for business partner qualification
Download OpenAPI description
Languages
Servers
Production
https://api.cdq.com/data-validation/rest/
Bodyapplication/jsonrequired
cmd
List of data sources should be used.
| Items Enum Value | Description |
|---|---|
| AR.NRC | Value indicating AR.NRC data source. |
| AT.CR | Value indicating AT.CR data source. |
| AT.FON | Value indicating AT.FON data source. |
| AU.BR | Value indicating AU.BR data source. |
| BR.RF | Value indicating BR.RF data source. |
| BZST | Value indicating BZST data source. |
| CA.CR | Value indicating CA.CR data source. |
| CH.UIDR | Value indicating CH.UIDR data source. |
| CZ.REE | Value indicating CZ.REE data source. |
| DK.CR | Value indicating DK.CR data source. |
Example: ["AR.NRC"]
Qualification profiles enum.
Default "EU_TAX_QUALIFICATION"
| Enum Value | Description |
|---|---|
| EU_TAX_QUALIFICATION | Default option. EU_TAX_QUALIFICATION profile for the Qualification process. |
| WORLDWIDE_TAX_QUALIFICATION | WORLDWIDE_TAX_QUALIFICATION profile for the Qualification process. |
Example: "EU_TAX_QUALIFICATION"
Request features that should be turned on.
| Items Enum Value | Description |
|---|---|
| SHOW_LOOKUP_RESULTS | Includes lookup results in the response. |
| SHOW_BUSINESS_PARTNER | Includes Business Partner in the response. |
| FORCE_EXTERNAL_CALL | Forces calls on external services ignoring cache. |
| SHOW_DEBUG_INFO | Shows additional information about validation process (number of applied rules, used categories, failed executions etc.). |
Example: ["FORCE_EXTERNAL_CALL"]
Request features that should be turned off.
| Items Enum Value | Description |
|---|---|
| SHOW_LOOKUP_RESULTS | Includes lookup results in the response. |
| SHOW_BUSINESS_PARTNER | Includes Business Partner in the response. |
| FORCE_EXTERNAL_CALL | Forces calls on external services ignoring cache. |
| SHOW_DEBUG_INFO | Shows additional information about validation process (number of applied rules, used categories, failed executions etc.). |
Example: ["FORCE_EXTERNAL_CALL"]
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.
- Production
https://api.cdq.com/data-validation/rest/v3/businesspartners/qualify
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X POST \
https://api.cdq.com/data-validation/rest/v3/businesspartners/qualify \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"profile": "EU_TAX_QUALIFICATION",
"businessPartner": {
"names": [
{
"value": "ATOS SPAIN SA"
}
],
"identifiers": [
{
"type": {
"technicalKey": "EU_VAT_ID_ES"
},
"value": "A28240752"
}
],
"addresses": [
{
"country": {
"shortName": "ES"
}
}
]
}
}'OK
List of Qualifications Results.
Reference implementation how to structure external service responses. Can be activated by a feature SHOW_DEBUG_INFO.
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.
Response
application/json
{ "qualificationResults": [ { … } ], "lookupResults": [ { … } ], "debugInfo": { "externalServiceResponses": [ … ], "businessRulesExecutionSummary": { … } } }