Qualification

Everything about Business Partner qualification

Qualify Business PartnerBETA

BETA
Endpoint used for Business Partner qualification. It is in BETA version and may change without notice.

SecurityapiKey

Request

Request Body schema: application/json
required

cmd

object (BusinessPartner)

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.

dataSources

Array of strings (DataSourcesEnum)

List of data sources should be used.

Items Enum:	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.
EU.EORI	Value indicating EU.EORI data source.
FR.RC	Value indicating FR.RC data source.
NO.RBE	Value indicating NO.RBE data source.
PL.NOBR	Value indicating PL.NOBR data source.
SG.BR	Value indicating SG.BR data source.
UK.EORI	Value indicating UK.EORI data source.
UK.VAT	Value indicating UK.VAT data source.
VIES	Value indicating VIES data source.

Example: ["AR.NRC"]

featuresOff

Array of strings (BusinessPartnerQualificationRequestFeaturesEnum)

Request features that should be turned off.

Items Enum:	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"]

featuresOn

Array of strings (BusinessPartnerQualificationRequestFeaturesEnum)

Request features that should be turned on.

Items Enum:	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"]

profile

string (BusinessPartnerQualificationRequestProfileEnum)

Default: "EU_TAX_QUALIFICATION"

Qualification profiles enum.

Enum:	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"

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

post/v3/businesspartners/qualify

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"profile": "EU_TAX_QUALIFICATION",
"businessPartner": {"names": [{"value": "ATOS SPAIN SA"
}
],
"identifiers": [{"type": {"technicalKey": "EU_VAT_ID_ES"
},
"value": "A28240752"
}
],
"addresses": [{"country": {"shortName": "ES"
}
}
]
}
}

Response samples

application/json

{"qualificationResults": [{"identifier": {"value": "A28240752",
"type": {"technicalKey": "EU_VAT_ID_ES"
}
},
"qualifiedAt": "2023-10-03T16:37:19.252354829",
"qualificationDecisionSummary": {"identifierQualificationDecision": "VALID",
"nameQualificationDecision": "VALID",
"addressQualificationDecision": "NO_INPUT_PROVIDED",
"addressQualificationDecisionDetails": {"localityQualificationDecision": "NO_INPUT_PROVIDED",
"postCodeQualificationDecision": "NO_INPUT_PROVIDED",
"thoroughfareQualificationDecision": "NO_INPUT_PROVIDED"
},
"overallQualificationDecision": "VALID"
},
"qualificationDecisionDetails": [{"businessRule": {"name": "Name Qualification (European value added tax identifier (Spain), Data source:VIES)",
"url": "https://meta.cdq.com/Name_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)",
"ruleStatus": "HYPERCARE",
"violationMessage": "Name deviates from the reference name registered with the European value added tax identifier (Spain)"
},
"executionContextProperties": [{"type": "qualificationTarget",
"value": "NAME_LOCAL"
},
{"type": "targetInputValue",
"value": "ATOS SPAIN SA"
},
{"type": "targetReferenceValue",
"value": "ATOS SPAIN SA"
}
],
"dataSourceTechnicalKey": "VIES",
"cdqId": "VIES:ESA28240752",
"decision": "VALID",
"error": { }
}
]
}
],
"lookupResults": [{"businessPartner": {"addresses": [{"version": {"characterSet": {"technicalKey": "LATIN"
},
"language": {"name": "en",
"technicalKey": "en"
}
},
"country": {"shortName": "ES",
"value": "Spain"
}
}
],
"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type/vat_registered_name",
"name": "VAT Registered Name",
"technicalKey": "VAT_REGISTERED"
},
"value": "ATOS SPAIN SA",
"language": { }
}
],
"identifiers": [{"value": "ESA28240752",
"type": {"url": "https://meta.cdq.com/European_value_added_tax_identifier_(Spain)",
"name": "Value added tax identification number",
"technicalKey": "EU_VAT_ID_ES"
},
"issuingBody": { }
}
],
"legalForm": {"name": "Sociedad Anónima",
"mainAbbreviation": "S.A.",
"url": "https://meta.cdq.com/Business_partner/legal_form/technical_key/ES_1035",
"technicalKey": "ES_1035"
},
"status": { },
"profile": { }
},
"address": { },
"dataSource": "VIES",
"cdqId": "VIES:ESA28240752"
}
],
"debugInfo": {"externalServiceResponses": [{"status": 200,
"timestamp": "2023-10-03T14:37:19.125086Z",
"additionalInformation": [{"key": "requestorId",
"value": "DE307699628"
},
{"key": "requestId",
"value": "WAPIAAAAYr1-NB3H"
},
{"key": "rawJson",
"value": "[{\"vatValue\":{\"value\":\"A28240752\"},\"requestDate\":{\"value\":\"2023-10-02T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"ES\"},\"valid\":{\"value\":true},\"traderAddress\":{},\"traderName\":{\"value\":\"ATOS SPAIN SA\"},\"traderCompanyType\":{},\"traderStreet\":{},\"traderPostcode\":{},\"traderCity\":{},\"traderNameMatch\":{\"value\":\"1\"},\"traderCompanyTypeMatch\":{\"value\":\"3\"},\"traderStreetMatch\":{\"value\":\"3\"},\"traderPostcodeMatch\":{\"value\":\"3\"},\"traderCityMatch\":{\"value\":\"3\"},\"requestIdentifier\":{\"value\":\"WAPIAAAAYr1-NB3H\"},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\"}]"
}
]
}
],
"businessRulesExecutionSummary": {"numberOfRules": 0,
"numberOfExecutions": 0,
"numberOfFails": 0
}
}
}

Qualification

Qualify Business PartnerBETA

Request Body schema: application/jsonrequired

Request Body schema: application/json
required