Skip to content

CX Pool API (1)

API for CX.POOL reviews

Overview
URL

https://www.cdq.com/about-cdq#cdq-team

Michał Malinka

michal.malinka@cdq.com

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/cx-pool-api/api-v1/

Production SOAP

https://cx-pool-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/soap/v1/

Production

https://cx-pool-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/

Sharing

Everything about Business Partners

Operations

Read Sharing Countries

Request

Read countries supported by sharing. The list of countries is used to validate the country codes in the sharing process.

Security
oAuth2
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take a form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/cx-pool-api/api-v1/sharing/businesspartners/supportedCountries \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
countriesArray of objects(SupportedCountry)

List of supported countries.

Response
application/json
{
  "countries": [
    { … }
  ]
}

Start Sharing Process

Request

Start sharing process for a BusinessPartner by providing a DataMirrorEvent

Security
oAuth2
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take a form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
storageOrganizationIdstring(OrganizationId)required

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
businessPartnerIdsArray of strings(BusinessPartnerId)required

List of Business Partner IDs.

Example: ["63e635235c06b7396330fe40"]
userIdstring(UserId)required

Unique ID of a user.

Example: "johndoe"
sharingTargetstring

The sharing target where the data should be shared.

Example: "CX.POOL"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/cx-pool-api/api-v1/sharing/businesspartners/dataMirrorEvent \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "storageId": "72d6900fce6b326088f5d9d91049e3e6",
    "storageOrganizationId": "cdq_monitor",
    "businessPartnerIds": [
      "63e635235c06b7396330fe40"
    ],
    "userId": "johndoe",
    "sharingTarget": "CX.POOL"
  }'

Responses

OK

Response
No content

Inspect Business Partner

Request

Inspect the given Business Partner if it can participate in the sharing process. Only for debug purposes.

Security
oAuth2
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take a form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired

The Business Partner which will be inspected for its feasibility to participate in a sharing process.

businessPartnerobject(BusinessPartner)required

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 CDQ context, the Business Partner is the core managed entity. 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.

businessPartner.​idstring(BusinessPartnerId)

A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League.

Example: "63e635235c06b7396330fe40"
businessPartner.​dataSourcestring(BusinessPartnerStorageDataSourceName)

Name of a data source of a storage.

Example: "Internal customers"
businessPartner.​externalIdstring(BusinessPartnerExternalId)

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."
businessPartner.​disclosedboolean

A flag to indicate whether the business partner should participate in the sharing or not. If 'true', this business partner might be used to create a new entry or update an existing entry in the community pool. Otherwise, it will not be considered for the sharing process.

Example: "true"
businessPartner.​namesArray of objects(Name)

List of the Business Partner names.

businessPartner.​legalFormobject(LegalForm)

The legal form of a Business Partner is the form it takes in the eyes of the law governing it. The legal form of a company 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 company's name (e.g., AG, Inc., LLC, S.A.).

businessPartner.​identifiersArray of objects(Identifier)

List of the Business Partner identifiers.

businessPartner.​categoriesArray of objects(BusinessPartnerCategory)

List of the Business Partner categories.

businessPartner.​statusobject(BusinessPartnerStatus)

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).

businessPartner.​metadataobject(BusinessPartnerMetadata)

Metadata of a Business Partner.

businessPartner.​addressesArray of objects(Address)

List of the Business Partner addresses.

businessPartner.​typesArray of objects(BusinessPartnerType)

List of the Business Partner types.

businessPartner.​recordstring

Stringified JSON of an individual Business Partner record.

Example: "{\"id\":\"1\",\"name\":\"John Doe\"}"
businessPartner.​profileobject(PartnerProfile)

A Business Partner profile contains important information about a company, such as its classification, tags, contact details, or minority indicator.

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/cx-pool-api/api-v1/sharing/businesspartners/inspectSharingStatus \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "businessPartner": {
      "id": "63e635235c06b7396330fe40",
      "dataSource": "Internal customers",
      "externalId": "The ID managed in the customer'\''s SAP systems.",
      "disclosed": "true",
      "names": [
        {
          "language": {
            "name": "German",
            "technicalKey": "DE"
          },
          "shortName": "CDQ AG",
          "type": {
            "url": "https://meta.cdq.com/Business_partner/name/type",
            "name": "Local Name",
            "technicalKey": "LOCAL"
          },
          "value": "Corporate Data Quality AG",
          "details": [
            {
              "value": "Corporate Data Quality AG - Marketing Department",
              "type": {
                "name": "Legal Entity",
                "url": "https://meta.cdq.com/Business_partner/type",
                "technicalKey": "LEGAL_ENTITY"
              }
            }
          ]
        }
      ],
      "legalForm": {
        "name": "Aktiengesellschaft",
        "url": "https://meta.cdq.com/Business_partner/legal_form",
        "technicalKey": "DE_9866",
        "language": {
          "name": "German",
          "technicalKey": "DE"
        },
        "mainAbbreviation": "AG"
      },
      "identifiers": [
        {
          "type": {
            "url": "https://meta.cdq.com/Business_partner/identifier/type",
            "name": "CH_VAT_ID",
            "technicalKey": "CH_VAT_ID"
          },
          "value": "CHE-218.608.886 HR/MWST",
          "issuingBody": {
            "url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
            "name": "Amtsgericht Aachen",
            "technicalKey": "Amtsgericht Aachen"
          },
          "status": {
            "name": "ACTIVE",
            "technicalKey": "ACTIVE"
          }
        }
      ],
      "categories": [
        {
          "name": "Hotel",
          "url": "https://meta.cdq.com/Business_partner/category",
          "technicalKey": "HOTEL"
        }
      ],
      "status": {
        "type": {
          "name": "In Liquidation",
          "url": "https://meta.cdq.com/Business_partner/status/type",
          "technicalKey": "IN_LIQUIDATION"
        },
        "officialDenotation": "Good Standing",
        "validFrom": "2022-02-26",
        "validUntil": "2022-02-26"
      },
      "metadata": {
        "status": {
          "recordStatus": "ACCEPTED",
          "explanations": [
            "The record is accepted."
          ]
        },
        "sharingStatus": {
          "status": "SHARED_WITH_NO_MATCH",
          "description": "The Business Partner is shared with no match."
        },
        "reason": "The Business Partner is not valid.",
        "identityLinks": [
          {
            "linkId": "6465f2492bdcd350159a79d6",
            "cdqId": "VIES:PL8660001429",
            "addressId": "0",
            "externalAddressId": "123456789"
          }
        ]
      },
      "addresses": [
        {
          "id": "1",
          "version": {
            "language": {
              "name": "German",
              "technicalKey": "DE"
            },
            "characterSet": {
              "name": "International",
              "technicalKey": "INTERNATIONAL"
            }
          },
          "externalId": "1",
          "country": {
            "shortName": "CH",
            "value": "Switzerland"
          },
          "administrativeAreas": [
            {
              "value": "Sankt Gallen",
              "shortName": "SG",
              "isoCode": "CH-SG",
              "type": {
                "name": "COUNTY",
                "url": "https://meta.cdq.com/Address/administrative_area/type",
                "technicalKey": "COUNTY"
              }
            }
          ],
          "postCodes": [
            {
              "value": "9000",
              "type": {
                "name": "Regular",
                "url": "https://meta.cdq.com/Address/post_code/type",
                "technicalKey": "REGULAR"
              }
            }
          ],
          "localities": [
            {
              "type": {
                "name": "City",
                "url": "https://meta.cdq.com/Address/locality/type",
                "technicalKey": "CITY"
              },
              "shortName": "St. Gallen",
              "value": "Sankt Gallen"
            }
          ],
          "thoroughfares": [
            {
              "type": {
                "name": "Industrial zone",
                "url": "https://meta.cdq.com/Address/thoroughfare/type",
                "technicalKey": "INDUSTRIAL_ZONE"
              },
              "shortName": "Lukasstr. 4",
              "number": "4",
              "direction": "221-bis Baker Street, North",
              "value": "Lukasstraße 4",
              "name": "Lukasstraße"
            }
          ],
          "premises": [
            {
              "value": "Lukasstraße 4",
              "shortName": "Lukasstr. 4",
              "number": "4",
              "type": {
                "name": "Factory",
                "url": "https://meta.cdq.com/Address/premise/type",
                "technicalKey": "FACTORY"
              }
            }
          ],
          "postalDeliveryPoints": [
            {
              "type": {
                "name": "Mailbox",
                "url": "https://meta.cdq.com/Address/postal_delivery_point/type",
                "technicalKey": "MAILBOX"
              },
              "shortName": "St Gallen, Postfach 460",
              "number": "460",
              "value": "Postfach"
            }
          ],
          "geographicCoordinates": {
            "latitude": "47.439549",
            "longitude": "9.395275"
          },
          "identifyingName": {
            "value": "John Doe"
          },
          "careOf": {
            "value": "CDQ GmbH c/o Product Department"
          },
          "contexts": [
            {
              "value": "Production hall 7, Storage field 8."
            }
          ],
          "types": [
            {
              "name": "Legal Address",
              "url": "https://meta.cdq.com/Address/type",
              "technicalKey": "LEGAL_ADDRESS"
            }
          ]
        }
      ],
      "types": [
        {
          "name": "Legal Entity",
          "url": "https://meta.cdq.com/Business_partner/type",
          "technicalKey": "LEGAL_ENTITY"
        }
      ],
      "record": "{\"id\":\"1\",\"name\":\"John Doe\"}",
      "profile": {
        "minorityIndicator": {
          "value": "Social enterprise"
        },
        "classifications": [
          {
            "value": "Manufacture of pesticides and other agrochemical products.",
            "code": "20.20Z",
            "type": {
              "name": "NAF 2003",
              "url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
              "technicalKey": "NAF 2003"
            }
          }
        ],
        "phoneNumbers": [
          {
            "countryPrefix": "+41",
            "number": "71 571 10 40",
            "type": {
              "name": "FAX",
              "url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
              "technicalKey": "FAX"
            },
            "value": "+41 71 571 10 40"
          }
        ],
        "websites": [
          {
            "url": "https://cdq.com",
            "type": {
              "name": "Corporate Website",
              "url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
              "technicalKey": "WEBSITE_TYPE_CORPORATE"
            }
          }
        ],
        "contactEmails": [
          {
            "value": "developer-portal@cdq.com"
          }
        ],
        "tags": [
          {
            "value": "Warehouse",
            "type": {
              "technicalKey": "WAREHOUSE"
            }
          }
        ]
      }
    }
  }'

Responses

OK

Bodyapplication/json
businessPartnerobject(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 CDQ context, the Business Partner is the core managed entity. 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.

Response
application/json
{
  "businessPartner": {
    "id": "63e635235c06b7396330fe40",
    "dataSource": "Internal customers",
    "externalId": "The ID managed in the customer's SAP systems.",
    "disclosed": "true",
    "names": [ … ],
    "legalForm": { … },
    "identifiers": [ … ],
    "categories": [ … ],
    "status": { … },
    "metadata": { … },
    "addresses": [ … ],
    "types": [ … ],
    "record": "{\"id\":\"1\",\"name\":\"John Doe\"}",
    "profile": { … }
  }
}

Lookup Business Partner

Request

Lookup business partners in the CDQ Community Pool.

Security
oAuth2
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take a form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired

request

storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
businessPartnerIdstring(BusinessPartnerId)required

A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League.

Example: "63e635235c06b7396330fe40"
businessPartnerobject(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 CDQ context, the Business Partner is the core managed entity. 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.

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/cx-pool-api/api-v1/sharing/businesspartners/lookup \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "storageId": "72d6900fce6b326088f5d9d91049e3e6",
    "businessPartnerId": "63e635235c06b7396330fe40",
    "businessPartner": {
      "id": "63e635235c06b7396330fe40",
      "dataSource": "Internal customers",
      "externalId": "The ID managed in the customer'\''s SAP systems.",
      "disclosed": "true",
      "names": [
        {
          "language": {
            "name": "German",
            "technicalKey": "DE"
          },
          "shortName": "CDQ AG",
          "type": {
            "url": "https://meta.cdq.com/Business_partner/name/type",
            "name": "Local Name",
            "technicalKey": "LOCAL"
          },
          "value": "Corporate Data Quality AG",
          "details": [
            {
              "value": "Corporate Data Quality AG - Marketing Department",
              "type": {
                "name": "Legal Entity",
                "url": "https://meta.cdq.com/Business_partner/type",
                "technicalKey": "LEGAL_ENTITY"
              }
            }
          ]
        }
      ],
      "legalForm": {
        "name": "Aktiengesellschaft",
        "url": "https://meta.cdq.com/Business_partner/legal_form",
        "technicalKey": "DE_9866",
        "language": {
          "name": "German",
          "technicalKey": "DE"
        },
        "mainAbbreviation": "AG"
      },
      "identifiers": [
        {
          "type": {
            "url": "https://meta.cdq.com/Business_partner/identifier/type",
            "name": "CH_VAT_ID",
            "technicalKey": "CH_VAT_ID"
          },
          "value": "CHE-218.608.886 HR/MWST",
          "issuingBody": {
            "url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
            "name": "Amtsgericht Aachen",
            "technicalKey": "Amtsgericht Aachen"
          },
          "status": {
            "name": "ACTIVE",
            "technicalKey": "ACTIVE"
          }
        }
      ],
      "categories": [
        {
          "name": "Hotel",
          "url": "https://meta.cdq.com/Business_partner/category",
          "technicalKey": "HOTEL"
        }
      ],
      "status": {
        "type": {
          "name": "In Liquidation",
          "url": "https://meta.cdq.com/Business_partner/status/type",
          "technicalKey": "IN_LIQUIDATION"
        },
        "officialDenotation": "Good Standing",
        "validFrom": "2022-02-26",
        "validUntil": "2022-02-26"
      },
      "metadata": {
        "status": {
          "recordStatus": "ACCEPTED",
          "explanations": [
            "The record is accepted."
          ]
        },
        "sharingStatus": {
          "status": "SHARED_WITH_NO_MATCH",
          "description": "The Business Partner is shared with no match."
        },
        "reason": "The Business Partner is not valid.",
        "identityLinks": [
          {
            "linkId": "6465f2492bdcd350159a79d6",
            "cdqId": "VIES:PL8660001429",
            "addressId": "0",
            "externalAddressId": "123456789"
          }
        ]
      },
      "addresses": [
        {
          "id": "1",
          "version": {
            "language": {
              "name": "German",
              "technicalKey": "DE"
            },
            "characterSet": {
              "name": "International",
              "technicalKey": "INTERNATIONAL"
            }
          },
          "externalId": "1",
          "country": {
            "shortName": "CH",
            "value": "Switzerland"
          },
          "administrativeAreas": [
            {
              "value": "Sankt Gallen",
              "shortName": "SG",
              "isoCode": "CH-SG",
              "type": {
                "name": "COUNTY",
                "url": "https://meta.cdq.com/Address/administrative_area/type",
                "technicalKey": "COUNTY"
              }
            }
          ],
          "postCodes": [
            {
              "value": "9000",
              "type": {
                "name": "Regular",
                "url": "https://meta.cdq.com/Address/post_code/type",
                "technicalKey": "REGULAR"
              }
            }
          ],
          "localities": [
            {
              "type": {
                "name": "City",
                "url": "https://meta.cdq.com/Address/locality/type",
                "technicalKey": "CITY"
              },
              "shortName": "St. Gallen",
              "value": "Sankt Gallen"
            }
          ],
          "thoroughfares": [
            {
              "type": {
                "name": "Industrial zone",
                "url": "https://meta.cdq.com/Address/thoroughfare/type",
                "technicalKey": "INDUSTRIAL_ZONE"
              },
              "shortName": "Lukasstr. 4",
              "number": "4",
              "direction": "221-bis Baker Street, North",
              "value": "Lukasstraße 4",
              "name": "Lukasstraße"
            }
          ],
          "premises": [
            {
              "value": "Lukasstraße 4",
              "shortName": "Lukasstr. 4",
              "number": "4",
              "type": {
                "name": "Factory",
                "url": "https://meta.cdq.com/Address/premise/type",
                "technicalKey": "FACTORY"
              }
            }
          ],
          "postalDeliveryPoints": [
            {
              "type": {
                "name": "Mailbox",
                "url": "https://meta.cdq.com/Address/postal_delivery_point/type",
                "technicalKey": "MAILBOX"
              },
              "shortName": "St Gallen, Postfach 460",
              "number": "460",
              "value": "Postfach"
            }
          ],
          "geographicCoordinates": {
            "latitude": "47.439549",
            "longitude": "9.395275"
          },
          "identifyingName": {
            "value": "John Doe"
          },
          "careOf": {
            "value": "CDQ GmbH c/o Product Department"
          },
          "contexts": [
            {
              "value": "Production hall 7, Storage field 8."
            }
          ],
          "types": [
            {
              "name": "Legal Address",
              "url": "https://meta.cdq.com/Address/type",
              "technicalKey": "LEGAL_ADDRESS"
            }
          ]
        }
      ],
      "types": [
        {
          "name": "Legal Entity",
          "url": "https://meta.cdq.com/Business_partner/type",
          "technicalKey": "LEGAL_ENTITY"
        }
      ],
      "record": "{\"id\":\"1\",\"name\":\"John Doe\"}",
      "profile": {
        "minorityIndicator": {
          "value": "Social enterprise"
        },
        "classifications": [
          {
            "value": "Manufacture of pesticides and other agrochemical products.",
            "code": "20.20Z",
            "type": {
              "name": "NAF 2003",
              "url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
              "technicalKey": "NAF 2003"
            }
          }
        ],
        "phoneNumbers": [
          {
            "countryPrefix": "+41",
            "number": "71 571 10 40",
            "type": {
              "name": "FAX",
              "url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
              "technicalKey": "FAX"
            },
            "value": "+41 71 571 10 40"
          }
        ],
        "websites": [
          {
            "url": "https://cdq.com",
            "type": {
              "name": "Corporate Website",
              "url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
              "technicalKey": "WEBSITE_TYPE_CORPORATE"
            }
          }
        ],
        "contactEmails": [
          {
            "value": "developer-portal@cdq.com"
          }
        ],
        "tags": [
          {
            "value": "Warehouse",
            "type": {
              "technicalKey": "WAREHOUSE"
            }
          }
        ]
      }
    }
  }'

Responses

OK

Bodyapplication/json
totalinteger

Total number of matches.

Example: "5"
valuesArray of objects(BusinessPartnerLookupMatch)

List of Business Partner lookup matches.

debugInfoobject

Debug information.

Response
application/json
{
  "total": "5",
  "values": [
    { … }
  ],
  "debugInfo": {
    "request": { … }
  }
}

Link Business Partner

Request

Link business partner with the CDQ Community Pool. Only business partner which is in status PENDING_LINKAGE_DECISION is allowed.

In successful case, execution finishes in the following states: | Review decision | Sharing status | | IGNORE | | LINK | SHARED_BY_REVIEW | | LINK_AND_SEND_UPDATE | SHARED_BY_REVIEW |

status field is OK in case of successful linkage or FAILED in case of failure. message field presents the reason of failure.

In case the business partner contents have been changed, the status can be different and will be visible in the result.

Security
oAuth2
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take a form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired

request

decisionstring(ReviewDecisionParam)required

Review decision parameter.

Enum ValueDescription
NO_MATCH

No match.

LINK

Link.

LINK_AND_SEND_UPDATE

Link and send update.

Example: "LINK"
cdqIdstring

CDQ ID of the reviewed Business Partner.

Example: "VIES:PL8660001429"
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
customerBusinessPartnerobject(ReviewDecisionBusinessPartner)required

Business Partner for review decision.

customerBusinessPartner.​idstring(BusinessPartnerId)required

A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League.

Example: "63e635235c06b7396330fe40"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/cx-pool-api/api-v1/sharing/reviewdecisions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "decision": "LINK",
    "cdqId": "VIES:PL8660001429",
    "storageId": "72d6900fce6b326088f5d9d91049e3e6",
    "customerBusinessPartner": {
      "id": "63e635235c06b7396330fe40"
    }
  }'

Responses

OK

Bodyapplication/json
cdqIdstring

CDQ ID of the reviewed Business Partner.

Example: "VIES:PL8660001429"
sharingStatusstring

Sharing status possible values:

  • UNDER_CONSIDERATION
  • UNDER_CONSIDERATION_COUNTRY
  • UNDER_CONSIDERATION_NOT_VALIDATED
  • UNDER_CONSIDERATION_MISSING_MATCH_TYPE
  • UNDISCLOSED_RECORD
  • MISSING_INFORMATION_FOR_LINKAGE
  • ERRONEOUS_INFORMATION_FOR_LINKAGE
  • ERRONEOUS_RECORD
  • SHARED_WITH_NO_MATCH_BY_REVIEW
  • SHARED_BY_REVIEW
  • PROCESS_ISSUE

Never reached statuses in this endpoint:

  • PENDING_LINKAGE_DECISION
  • SHARED_WITH_NO_MATCH
  • SHARED_WITH_CONFIDENT_MATCH
Example: "SHARED_BY_REVIEW"
statusstring

Status possible values:

  • OK - successfully shared.
  • FAILED - failed to share. See message field for details.
Example: "OK"
messagestring

Message in case of failure.

Example: "The Business Partner is not valid."
debugInfoobject

Debug information.

Response
application/json
{
  "cdqId": "VIES:PL8660001429",
  "sharingStatus": "SHARED_BY_REVIEW",
  "status": "OK",
  "message": "The Business Partner is not valid.",
  "debugInfo": {
    "request": { … }
  }
}

Review Decision Persists

Request

Test endpoint for persisting review decisions. It is used for testing purposes only.

Security
oAuth2
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take a form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired

request

decisionstring(ReviewDecisionParam)required

Review decision parameter.

Enum ValueDescription
NO_MATCH

No match.

LINK

Link.

LINK_AND_SEND_UPDATE

Link and send update.

Example: "LINK"
cdqIdstring

CDQ ID of the reviewed Business Partner.

Example: "VIES:PL8660001429"
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
customerBusinessPartnerobject(ReviewDecisionBusinessPartner)required

Business Partner for review decision.

customerBusinessPartner.​idstring(BusinessPartnerId)required

A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League.

Example: "63e635235c06b7396330fe40"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/cx-pool-api/api-v1/sharing/reviewdecisions/testReviewDecisionPersist \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "decision": "LINK",
    "cdqId": "VIES:PL8660001429",
    "storageId": "72d6900fce6b326088f5d9d91049e3e6",
    "customerBusinessPartner": {
      "id": "63e635235c06b7396330fe40"
    }
  }'

Responses

OK

Pool

Everything about the Pool

Operations

Cache

Everything about the Cache

Operations