Skip to content

SAP Business Network API (1)

API for SAP Business Network (BN) to simplify the integration of CDQ services.

Download OpenAPI description
api-v1.json
api-v1.yaml
Overview
License

Terms of Use for the CDQ Cloud Suite

Languages
Servers
Mock server

https://developer.cdq.com/_mock/apis/sap-business-network-api/api-v1/

Production

https://api.cdq.com/

Confirm Trading Partner Validity

Request

Confirms the validity of a trading partner by checking the provided data against various CDQ services.

The following examples are defined and can be requested by the example ID in header field x-redocly-response-body-example:

Example IDSummary
allOKAll checks confirm the trading partner's information successfully.
companyKnownButWrongStreetNoVatNumberCompany is known but the street is wrong and no VAT number is provided.
companyKnownButSanctionedCompany is known but on a sanction list.
companyNotKnownCompany is not known, i.e., the provided data cannot be verified by a Trusted Data Source.
Security
apiKey
Bodyapplication/jsonrequired
businessPartnerobject(BusinessPartner)

A Business Partner is globally uniquely identifiable by a CDQ ID, and all managed information such as addresses, documents, and hierarchies is linked to a Business Partner.

featuresOnArray of strings(ConfirmFeatureParam)

List of features to be activated.

Items Enum ValueDescription
ENABLE_SANCTION_CONFIRMATION

Sanction confirmation is used to confirm business partner.

ENABLE_QUALIFICATION_CONFIRMATION

Qualification functionality is used to confirm business partner.

Example: ["ENABLE_QUALIFICATION_CONFIRMATION"]
featuresOffArray of strings(ConfirmFeatureParam)

List of features to be deactivated.

Items Enum ValueDescription
ENABLE_SANCTION_CONFIRMATION

Sanction confirmation is used to confirm business partner.

ENABLE_QUALIFICATION_CONFIRMATION

Qualification functionality is used to confirm business partner.

Example: ["ENABLE_QUALIFICATION_CONFIRMATION"]
curl -i -X POST \
  https://developer.cdq.com/_mock/apis/sap-business-network-api/api-v1/sap-bn/data-clinic/rest/v2/businesspartners/confirm \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "businessPartner": {
      "jsonRecord": {
        "name": "CDQ GmbH",
        "vatNumber": "DE307699628",
        "country": "DE",
        "city": "Friedrichshafen",
        "postalCode": "88045",
        "street": "Albrechtstraße 8",
        "houseNumber": "8"
      }
    }
  }'

Responses

OK

Bodyapplication/json
statusobject(Status)

Details about the status or error of a service.

dataQualityConfirmationobject(DataQualityConfirmation)

Describes the outcome of data quality checks, including an overall decision and detailed reports of any issues found.

companyConfirmationobject(CompanyConfirmation)

Contains results of the company confirmation process, verifying the existence and registration details of the company against trusted databases.

qualificationConfirmationobject(QualificationConfirmation)

Outputs the results of VAT number validation checks against official tax databases to ensure its validity.

sanctionComplianceConfirmationobject(ScreeningComplianceConfirmation)

Provides outcomes of checks against compliance lists like sanctions or watch lists to verify if the trading partner is compliant with regulatory standards.

Response
application/json
{
  "status": {
    "code": 200,
    "technicalKey": "OK",
    "details": [ … ],
    "path": "/v2/businesspartners/lookup",
    "timestamp": "2019-08-31T16:47+00:00"
  },
  "dataQualityConfirmation": {
    "decision": { … },
    "details": { … },
    "summary": { … }
  },
  "companyConfirmation": {
    "decision": { … },
    "details": { … },
    "summary": { … }
  },
  "qualificationConfirmation": {
    "decision": { … },
    "details": { … },
    "summary": { … }
  },
  "sanctionComplianceConfirmation": {
    "decision": { … },
    "details": { … },
    "summary": { … }
  }
}