# Upsert Business Partners Upsert Business Partners in a Business Partner storage in batches. Maximum of 1000 Business Partners are allowed per batch. If no data source (via field: ) is provided and the storage has only one, then this data source will be used/set. Other options are to provide an existing data source in the request, which will then be taken for all the Business Partner or to provide a data source for each Business Partner individually. In the following cases an API error will be thrown: 1) given data source in the Request or the BusinessPartner is unknown 2) no data source given and more than one data source is attached to the storage To start upserting Business Partners into a storage, use the following request. The response is shown below. Upserting Business Partners enables automated data transformation from the field to the Business Partner model. It requires a Data Mapper Definition and assigned to field of a data source Business Partner is being upserted to. field requires stringified JSON. Characters: backslash and double quote must be escaped (respectively: and ). Fields containing are unallowed." To enable automated data transformation, one of the following features is required: - TRANSFORM_RECORD - synchronous transformation, limited for batch size <= 250, - ENABLE_ASYNC - asynchronous transformation. Enabled by default when TRANSFORM_RECORD is not requested. Automated data transformation can be executed together with the UPSERT_BY_EXTERNAL_ID feature, but it requires to provide external ID as a field of a Business Partner, which is preserved during the transformation. If there is no name typed LOCAL in and exists any name with empty type or not filled , it becomes name of type LOCAL. Warn: in order to support multiple data sources, include dataSource into the request, either in $.dataSource or $.businessPartners[*].dataSource. Otherwise, multiple data sources with no selection of data source will lead to "No DataSource was provided for the given Business Partners and the storage has more than one attached to it." exception. Limits Business Partner and Address fields have defined array size limits | Path | Max array size | |---|---| | $.businessPartners[*].names | 20 | | $.businessPartners[*].identifiers | 20 | | $.businessPartners[*].categories | 20 | | $.businessPartners[*].addresses | 20 | | $.businessPartners[*].relations | 20 | | $.businessPartners[*].types | 20 | | $.businessPartners[*].bankAccounts | 50 | | $.businessPartners[*].profile.websites | 20 | | $.businessPartners[*].profile.classifications | 20 | | $.businessPartners[*].profile.contactEmails | 20 | | $.businessPartners[*].profile.phoneNumbers | 20 | | $.businessPartners[].contexts | 100 | | $.businessPartners[].administrativeAreas | 20 | | $.businessPartners[].postCodes | 20 | | $.businessPartners[].localities | 20 | | $.businessPartners[].thoroughfares | 20 | | $.businessPartners[].premises | 20 | | $.businessPartners[].postalDeliveryPoints | 20 | | $.businessPartners[].types | 20 | Endpoint: PUT /v4/storages/{storageId}/businesspartners Version: 5 Security: apiKey ## Path parameters: - `storageId` (string, required) Unique identifier of the Storage. Example: "72d6900fce6b326088f5d9d91049e3e6" ## Request fields (application/json): - `dataSource` (string) Name or ID of a data source. Reflects the associated external system where the record originates from. Example: "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"" - `businessPartners` (array, required) List of Business Partners. - `businessPartners.id` (string) A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League. Example: "63e635235c06b7396330fe40" - `businessPartners.createdAt` (string) Date of creation (ISO 8601-compliant). Example: "2025-09-10T10:12:36Z" - `businessPartners.modifiedAt` (string) Date of modification (ISO 8601-compliant). Example: "2025-09-10T10:12:36Z" - `businessPartners.externalId` (string) 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." - `businessPartners.disclosed` (boolean) 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. For more details, you can read about [Sharing Scopes](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Business-Partner-Storages/paths/~1v4~1storages~1%7BstorageId%7D~1sharingscopes/post/). Example: "false" - `businessPartners.updateMonitoring` (boolean) A flag to indicate whether the Business Partner should receive updates from non-commercial Reference Data Sources or not. If 'true' this Business Partner will receive updates since the change from 'false'. If 'false' this Business Partner will not receive any new updates since the change. If not provided, the previous value will not be changed. By default, Update Monitoring is activated. Example: "true" - `businessPartners.updateCommercialMonitoring` (array) Enabling update commercial monitoring has 2 possibilities: * via Data Mapper Definition: include mapping of updateCommercialMonitoring in the Data Mapper Definition * via direct Business Partner model upload: fill complete Business Partner model and . Null/undefined results in protection of this setup from the previous upsert. Empty or filled results in data transition that may link or unlink to / from respective commercial Reference Data Source Note: follow the approach that is currently used in your storage integration. - `businessPartners.updateCommercialMonitoring.type` (object, required) Type of the Business Partner Update Commercial Monitoring. - `businessPartners.updateCommercialMonitoring.type.technicalKey` (string) Name of commercial Reference Data Source that from which the Business Partner should receive updates. Possible values: * [DNB](https://directplus.documentation.dnb.com/openAPI.html?apiID=cmpelkv2) ([wiki](https://meta.cdq.com/Data_source/DNB)) * [DNB_MASTER_DATA_BASIC](https://directplus.documentation.dnb.com/DataBlocks.html?apiID=dataBlocks&blockIDs=companyinfo_L1_v1) ([wiki](https://meta.cdq.com/Data_source/DNB.MASTER.DATA.BASIC)) * [DNB_MASTER_DATA_EXTENDED](https://directplus.documentation.dnb.com/DataBlocks.html?apiID=dataBlocks&blockIDs=companyinfo_L2_v1,principalscontacts_L2_v2,hierarchyconnections_L1_v1) ([wiki](https://meta.cdq.com/Data_source/DNB.MASTER.DATA.EXTENDED)) * [DNB_LINKAGE_LNKELI](https://directplus.documentation.dnb.com/openAPI.html?apiID=lnkeli) ([wiki](https://meta.cdq.com/Data_source/DNB.LINKAGE.LNKELI)) Example: "DNB" - `businessPartners.updateCommercialMonitoring.value` (boolean, required) Value of the Business Partner Update Commercial Monitoring. If 'true', the monitoring of this record will be activated on the commercial data source and this Business Partner will receive updates from that source. If 'false', the monitoring of this record will be deactivated in the commercial data source and this Business Partner will not receive any new updates from that source. By default, Update Commercial Monitoring is NOT activated. Example: "true" - `businessPartners.metadata` (object) Information about results of Business Partner processing. - `businessPartners.metadata.sharingStatus` (object) Business Partner Sharing Statuses. - `businessPartners.metadata.sharingStatus.status` (string) Sharing Status: * - The business partner violates at least one rule for required parameters defined by collaboration linkage strategy so can not be shared. * - The business partner violates at least one rule that leads to an overall data validation result of ERROR, and can not be shared. * - The business partner has missing at least one of required parameters defined by collaboration linkage strategy so can not be shared. * - The record was identified as natural person and is therefore excluded from the sharing. * - As the matching result was uncertain the business partner is currently waiting to be reviewed before it can be shared. * - During the last attempt to share the business partner process issue occurred. This business partner will be processed again. * - No match could be found and therefore the business partner was added to the community pool as a new business partner. * - A confident match was found and therefore the business partner was linked to an existing business partner in the community pool. * - Review decision has been made and the business partner was added to the community pool as a new business partner. * - Review decision has been made and the business partner was linked to an existing business partner in the community pool. * - The business partner will be considered for the sharing process. * - During the last attempt to share the business partner it was marked as 'undisclosed' and for that reason not considered. Example: "SHARED_WITH_NO_MATCH" - `businessPartners.metadata.sharingStatus.description` (string) A description of the sharing status. This is a human-readable description of the sharing status. Example: "UNDER_CONSIDERATION: The business partner will be considered for the sharing process." - `businessPartners.metadata.identityLinks` (array) List of Identity Links. - `businessPartners.metadata.identityLinks.linkId` (string) Unique identifier for the link between the business partner and the sharing pool. Example: "6465f2492bdcd350159a79d6" - `businessPartners.metadata.identityLinks.cdqId` (string) Unique identifier for the Business Partner. Example: "VIES:PL8660001429" - `businessPartners.metadata.identityLinks.addressId` (string) Unique identifier for the address which was used for the linkage in the POOL. Example: "0" - `businessPartners.metadata.identityLinks.externalAddressId` (string) Unique identifier from an external source for the address which was used for the linkage in the POOL. Example: "123456789" - `businessPartners.metadata.logResultStatuses` (array) List of Log Result Statuses. - `businessPartners.metadata.logResultStatuses.processingLogId` (string) Unique identifier of a processing log. Example: "CURATION_LOG" - `businessPartners.metadata.logResultStatuses.triggerProcessedAt` (string) Time when this log result has been processed by trigger. Example: "2025-09-10T10:12:36Z" - `businessPartners.metadata.logResultStatuses.triggerType` (object) Type of processing triggers. - `businessPartners.metadata.logResultStatuses.triggerType.name` (string) Name of processing trigger reason. Example: "CREATED" - `businessPartners.metadata.logResultStatuses.triggerType.technicalKey` (string) Technical Key of the processing trigger reason. Example: "CREATED" - `businessPartners.metadata.logResultStatuses.trigger` (object) Processing trigger reason. - `businessPartners.metadata.logResultStatuses.trigger.processedAt` (string) Time when this log result has been processed by trigger. Example: "2025-09-10T10:12:36Z" - `businessPartners.metadata.logResultStatuses.trigger.provenance` (object) Processing trigger provenance. - `businessPartners.metadata.logResultStatuses.trigger.provenance.name` (string) Display Name of the Provenance Name. Example: "VIES" - `businessPartners.metadata.logResultStatuses.trigger.provenance.technicalKey` (string) Technical Key of the Provenance Name. Example: "VIES" - `businessPartners.metadata.logResultStatuses.trigger.provenance.cdqId` (string) The ID provided for a linkage with the source by CDQ. Example: "VIES:PL8660001429" - `businessPartners.metadata.logResultStatuses.trigger.type` (object) Type of processing triggers. - `businessPartners.metadata.logResultStatuses.jobProcessedAt` (string) Time when this log result has been processed by job. Example: "2025-09-10T10:12:36Z" - `businessPartners.metadata.logResultStatuses.processedAt` (string) Time when this log result has been processed. Example: "2025-09-10T10:12:36Z" - `businessPartners.metadata.logResultStatuses.status` (string) Status of log result. Example: "INFO" - `businessPartners.metadata.logResultStatuses.description` (string) Description of log result. Example: "Validation Level" - `businessPartners.metadata.logResultStatuses.processingStatus` (object) Processing status. - `businessPartners.metadata.logResultStatuses.processingStatus.technicalKey` (string) Possible technical states of processing. Example: "IN_PROGRESS" - `businessPartners.metadata.decisionLogResult` (object) Outcome of a decision-making process based on a decision log. - `businessPartners.metadata.decisionLogResult.reviewStatus` (string) Review status of the Business Partner. Enum: "REVIEWED", "NOT_REVIEWED" - `businessPartners.metadata.decisionLogResult.naturalPersonsReviewStatus` (string) Review status of the Business Partner. Enum: "REVIEWED", "NOT_REVIEWED" - `businessPartners.metadata.decisionLogResult.duplicatesReviewStatus` (string) Review status of the Business Partner. Enum: "REVIEWED", "NOT_REVIEWED" - `businessPartners.record` (string) Stringified JSON of an individual Business Partner record. Characters: backslash and double quote must be escaped (respectively: and ). Fields containing are unallowed. Maximum size: 15MB. Example: "{\"name\": \"BUSINESSPARTNER_NAME\", ...}" - `businessPartners.names` (array) List of names. - `businessPartners.names.type` (object) The type of the name, e.g. a locally used name or an international version. - `businessPartners.names.type.url` (string) URL to the documentation which summarizes all details of the [Name Type](https://meta.cdq.com/Business_partner/name/type). Example: "https://meta.cdq.com/Business_partner/name/type" - `businessPartners.names.type.name` (string) Display label for the Name Type. Example: "Local Name" - `businessPartners.names.type.technicalKey` (string) Technical Keys of the Name Type. Example: "LOCAL" - `businessPartners.names.value` (string) The actual name. Example: "Corporate Data Quality AG" - `businessPartners.names.shortName` (string) The abbreviated variant of a company's full name. Example: "CDQ AG" - `businessPartners.names.language` (object) Naming of a language according to ISO 639-1. - `businessPartners.names.language.name` (string) ISO 639-1 name of language. Example: "German" - `businessPartners.names.language.technicalKey` (string) ISO 639-1 two-letter code of languages. Example: "DE" - `businessPartners.names.details` (array) - `businessPartners.names.details.value` (string) Value of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name). Example: "Corporate Data Quality AG - Marketing Department" - `businessPartners.names.details.type` (object) Type of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name). - `businessPartners.names.details.type.name` (string) Name Detail Type Name of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name). Example: "Legal Entity" - `businessPartners.names.details.type.url` (string) Name Detail Type Url of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name). Example: "https://meta.cdq.com/Business_partner/type" - `businessPartners.names.details.type.technicalKey` (string) Name Detail Type Technical Key of additional information to a [Business Partner Name](https://meta.cdq.com/Business_partner/name). Example: "LEGAL_ENTITY" - `businessPartners.legalForm` (object) The legal form of a [business partner/type/legal entity](https://meta.cdq.com/Business_partner/type/legal_entity) is the form it takes in the eyes of the law governing it. The legal form of a [company](https://meta.cdq.com/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 [company](https://meta.cdq.com/Business_partner)'s name (e.g. AG, Inc., LLC, S.A.). - `businessPartners.legalForm.name` (string) Display of the Legal Form. Example: "Aktiengesellschaft" - `businessPartners.legalForm.url` (string) URL to the documentation which summarizes all details of [Legal Form](https://meta.cdq.com/Business_partner/legal_form). Example: "https://meta.cdq.com/Business_partner/legal_form" - `businessPartners.legalForm.technicalKey` (string) Technical Key of a Legal Form. Descriptions of below enums contain , and . Example: "DE_9866" - `businessPartners.legalForm.mainAbbreviation` (string) The primary abbreviation of a legal form, i.e. the most commonly used abbreviation in a country. Example: "AG" - `businessPartners.legalForm.categories` (array) List of Legal Form Categories. - `businessPartners.legalForm.categories.name` (string) Descriptive display name of the Legal Form Category. Example: "Limited Liability Company" - `businessPartners.legalForm.categories.shortName` (string) Short display name of the Legal Form Category. Example: "LLC" - `businessPartners.legalForm.categories.url` (string) URL to the documentation which summarizes all details of the [Legal Form Category](https://meta.cdq.com/Business_partner/legal_form/category). Example: "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001" - `businessPartners.legalForm.categories.technicalKey` (string) Technical Key of the [Legal Form Category](https://meta.cdq.com/Business_partner/legal_form/category). Example: "LIMITED" - `businessPartners.identifiers` (array) List of Identifiers. - `businessPartners.identifiers.type` (object) Type of the identifier. - `businessPartners.identifiers.type.url` (string) URL to the documentation which summarizes all details of an [Identifier](https://meta.cdq.com/Business_partner/identifier/type). Example: "https://meta.cdq.com/Business_partner/identifier/type" - `businessPartners.identifiers.type.name` (string) Display label for the Identifier. Example: "CH_VAT_ID" - `businessPartners.identifiers.type.technicalKey` (string) Technical key of the type of the Identifier. Example: "CH_VAT_ID" - `businessPartners.identifiers.value` (string) Value of the identifier. Example: "CHE-218.608.886 HR/MWST" - `businessPartners.identifiers.issuingBody` (object) An Issuing Body is an organization or government institution that is responsible for assigning unique identifiers to individuals, organizations, or objects. - `businessPartners.identifiers.issuingBody.name` (string) Preferred display label for an Issuing Body. Example: "Amtsgericht Aachen" - `businessPartners.identifiers.issuingBody.url` (string) URL to the documentation which summarizes all details of a [Issuing Body](https://meta.cdq.com/Business_partner/identifier/issuing_body). Example: "https://meta.cdq.com/Business_partner/identifier/issuing_body" - `businessPartners.identifiers.issuingBody.technicalKey` (string) Technical key of the Issuing Body. Example: "Amtsgericht Aachen" - `businessPartners.identifiers.issuingBody.jurisdiction` (object) The authority of an official organization to make decisions and judgments in a particular administrative area. - `businessPartners.identifiers.issuingBody.jurisdiction.country` (object) Country consisting of the country name and country code (ISO 3166-1 alpha-2). - `businessPartners.identifiers.issuingBody.jurisdiction.country.shortName` (string) Country code (ISO 3166-1 alpha-2). Example: "CH" - `businessPartners.identifiers.issuingBody.jurisdiction.country.value` (string) Country name (ISO 3166-1 alpha-2). Example: "Switzerland" - `businessPartners.identifiers.status` (object) Describes the status of an identifier with respect to its level of activity (e.g. out of business) or legally relevant conditions (e.g. in liquidation). - `businessPartners.identifiers.status.name` (string) Display label for the Identifier Status Name. Example: "ACTIVE" - `businessPartners.identifiers.status.technicalKey` (string) Technical key of the Identifier Status. Example: "ACTIVE" - `businessPartners.categories` (array) List of Categories. - `businessPartners.categories.name` (string) Display name of the Business Partner Category Name. Example: "Hotel" - `businessPartners.categories.url` (string) URL to the documentation which summarizes all details of the [Business Partner Category](https://meta.cdq.com/Business_partner/category). Example: "https://meta.cdq.com/Business_partner/category" - `businessPartners.categories.technicalKey` (string) Technical Key of the Business Partner Category. Example: "HOTEL" - `businessPartners.status` (object) 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). - `businessPartners.status.type` (object) The standardized status which the business partner currently has. - `businessPartners.status.type.name` (string) Display name of the Business Partner Status. Example: "In Liquidation" - `businessPartners.status.type.url` (string) URL to the documentation which summarizes all details of the [Business Partner Status](https://meta.cdq.com/Business_partner/status/type). Example: "https://meta.cdq.com/Business_partner/status/type" - `businessPartners.status.type.technicalKey` (string) Technical Key of the Business Parter Status. Example: "IN_LIQUIDATION" - `businessPartners.status.officialDenotation` (string) The status as provided by an official register. Example: "Good Standing" - `businessPartners.status.validFrom` (string) 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: "2025-09-10T10:12:36Z" - `businessPartners.status.validUntil` (string) 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: "2025-09-10T10:12:36Z" - `businessPartners.profile` (object) Additional documentation can be found [here](https://meta.cdq.com/Partner_profile). - `businessPartners.profile.minorityIndicator` (object) 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. This feature is as of today dependent on data provided by a US based company: SupplierGateway. Additional documentation can be found [here](https://meta.cdq.com/Business_partner/partner_profile/minority_indicator). - `businessPartners.profile.minorityIndicator.value` (string) The actual value of the minority indicator, representing the minority group. Example: "Social enterprise" - `businessPartners.profile.classifications` (array) List of Classifications. - `businessPartners.profile.classifications.value` (string) A textual description of the Classification. Example: "Manufacture of pesticides and other agrochemical products." - `businessPartners.profile.classifications.code` (string) Code that classifies the business partner. Example: "20.20Z" - `businessPartners.profile.classifications.type` (object) Type of classification such as NACE, SIC, NAF or other industry classification standards. - `businessPartners.profile.classifications.type.name` (string) Display label for the Classification Type. Example: "NAF 2003" - `businessPartners.profile.classifications.type.url` (string) URL to the documentation which summarizes all details of the [Classification Type](https://meta.cdq.com/Business_partner/partner_profile/classification/type) Example: "https://meta.cdq.com/Business_partner/partner_profile/classification/type" - `businessPartners.profile.classifications.type.technicalKey` (string) TechnicalKey for the Classification Type. Example: "NAF 2003" - `businessPartners.profile.phoneNumbers` (array) List of Phone Numbers. - `businessPartners.profile.phoneNumbers.countryPrefix` (string) The country prefix of a phone number. Example: "+41" - `businessPartners.profile.phoneNumbers.number` (string) The complete phone number without any country prefixes. Example: "71 571 10 40" - `businessPartners.profile.phoneNumbers.type` (object) The type of phone number such as mobile phone or fixed line [here](https://meta.cdq.com/Business_partner/partner_profile/phone_number/type). - `businessPartners.profile.phoneNumbers.type.name` (string) Display label for a Phone Number Type Name. Example: "FAX" - `businessPartners.profile.phoneNumbers.type.url` (string) URL to the documentation which summarizes all details of the [Phone Number Type](https://meta.cdq.com/Business_partner/partner_profile/phone_number/type). Example: "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type" - `businessPartners.profile.phoneNumbers.type.technicalKey` (string) Technical Keys of the PhoneNumber. Example: "FAX" - `businessPartners.profile.phoneNumbers.value` (string) The actual complete phone number incl. country prefix. Example: "+41 71 571 10 40" - `businessPartners.profile.websites` (array) List of Websites. - `businessPartners.profile.websites.url` (string) The actual company website URL. Example: "https://cdq.com" - `businessPartners.profile.websites.type` (object) Describes the type of website of a business partner, e.g. corporate website, official LinkedIn profile, etc. - `businessPartners.profile.websites.type.name` (string) Display label for a Website Type Name Example: "Corporate Website" - `businessPartners.profile.websites.type.url` (string) URL to the documentation which summarizes [Website Type Name](https://meta.cdq.com/Business_Partner/partner_profile/website/type). Example: "https://meta.cdq.com/Business_Partner/partner_profile/website/type" - `businessPartners.profile.websites.type.technicalKey` (string) Technical Keys of the Website Type Name. Example: "WEBSITE_TYPE_CORPORATE" - `businessPartners.profile.contactEmails` (array) List of Contact Emails. - `businessPartners.profile.contactEmails.value` (string) Value of the email address of the Business Partner. Example: "developer-portal@cdq.com" - `businessPartners.profile.tags` (array) List of Tags. - `businessPartners.profile.tags.value` (string) Value of the tag. Example: "Warehouse" - `businessPartners.profile.tags.type` (object) A type that specifies the nature of the tag. - `businessPartners.profile.tags.type.technicalKey` (string, required) Technical Key of the Tag. Example: "WAREHOUSE" - `businessPartners.profile.vatPayerStatus` (object) Shows whether the Business Partner is a VAT payer. - `businessPartners.profile.vatPayerStatus.publicationDate` (string) Date of publication Example: "2025-09-10T10:12:36Z" - `businessPartners.profile.vatPayerStatus.status` (object) Payer Status. - `businessPartners.profile.vatPayerStatus.status.name` (string) Name of Vat payer status. Available values RELIABLE and UNRELIABLE Example: "RELIABLE" - `businessPartners.profile.vatPayerStatus.status.technicalKey` (string) Technical key of Vat payer status Example: "VAT_PAYER_STATUS" - `businessPartners.profile.vatPayerStatus.registrationAuthority` (object) Shows the registration authority of the Business Partner. - `businessPartners.profile.vatPayerStatus.registrationAuthority.registrationAuthorityId` (string) The reference code of the registration authority, taken from the Registration Authorities Code List maintained by GLEIF. Example: "RA000009" - `businessPartners.profile.vatPayerStatus.registrationAuthority.registrationAuthorityEntityId` (string) The identifier of the Entity at the indicated registration authority. Example: "RA000009" - `businessPartners.profile.vatPayerStatus.registrationAuthority.otherRegistrationAuthorityId` (string) A legacy / historical reference code of a registration authority. Example: "RA000009" - `businessPartners.profile.hcpProfile` (object) Healthcare Professional Profile informs about the status, licenses, and location of a natural person who is a member of the medical, dental, pharmacy, or nursing professions or any other person who, in the course of his/her professional activities, may prescribe, purchase, supply, recommend or administer a Medicinal Product and whose primary practice, principal professional address or place of incorporation is in Europe. - `businessPartners.profile.hcpProfile.generalLicense` (object) The general license of the Healthcare Professional. - `businessPartners.profile.hcpProfile.generalLicense.professionType` (object) The profession type of the Healthcare Professional. - `businessPartners.profile.hcpProfile.generalLicense.professionType.name` (string) Name of the profession type. Example: "Doctor" - `businessPartners.profile.hcpProfile.generalLicense.professionType.url` (string) URL to the documentation of the Profession Type Technical Key. Example: "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key" - `businessPartners.profile.hcpProfile.generalLicense.professionType.technicalKey` (string) Technical key of the profession type. Example: "DOCTOR" - `businessPartners.profile.hcpProfile.generalLicense.licenseStatus` (object) The license status of the Healthcare Professional. - `businessPartners.profile.hcpProfile.generalLicense.licenseStatus.name` (string) Name of the license status. Example: "Granted" - `businessPartners.profile.hcpProfile.generalLicense.licenseStatus.url` (string) URL to the documentation of the License Status Technical Key. Example: "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key" - `businessPartners.profile.hcpProfile.generalLicense.licenseStatus.technicalKey` (string) Technical key of the license status. Example: "GRANTED" - `businessPartners.profile.hcpProfile.operationalPermissions` (array) Operational permissions of the Healthcare Professional. - `businessPartners.profile.hcpProfile.operationalPermissions.issuingAuthority` (string) The issuing authority of the operational permission. Example: "Swiss Medical Association" - `businessPartners.profile.hcpProfile.operationalPermissions.permissionStatus` (object) The permission status of the operational permission. - `businessPartners.profile.hcpProfile.operationalPermissions.permissionStatus.name` (string) Name of the permission status. Example: "Granted" - `businessPartners.profile.hcpProfile.operationalPermissions.permissionStatus.url` (string) URL to the documentation of the Permission Status Technical Key. Example: "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/permission_status/url" - `businessPartners.profile.hcpProfile.operationalPermissions.permissionStatus.technicalKey` (string) Technical key of the permission status. Example: "GRANTED" - `businessPartners.profile.hcpProfile.operationalPermissions.activityStatus` (object) The activity status of the operational permission. - `businessPartners.profile.hcpProfile.operationalPermissions.activityStatus.name` (string) Name of the activity status. Possible values: * Active - The operational permission is active. * Inactive - The operational permission is inactive. Example: "Inactive" - `businessPartners.profile.hcpProfile.operationalPermissions.activityStatus.url` (string) URL to the documentation of the Activity Status Technical Key. Example: "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/activity_status/url" - `businessPartners.profile.hcpProfile.operationalPermissions.activityStatus.technicalKey` (string) Technical key of the activity status. Example: "INACTIVE" - `businessPartners.profile.hcpProfile.operationalPermissions.practiceLocations` (array) Practice locations of the Healthcare Professional. - `businessPartners.profile.hcpProfile.operationalPermissions.practiceLocations.practiceName` (string) The practice location of the Healthcare Professional. Example: "VIVOMED AG" - `businessPartners.profile.hcpProfile.operationalPermissions.practiceLocations.selfDispensationStatus` (object) The self-dispensation status of the Healthcare Professional. - `businessPartners.profile.hcpProfile.operationalPermissions.practiceLocations.selfDispensationStatus.name` (string) Name of the self-dispensation status. Example: "No" - `businessPartners.profile.hcpProfile.operationalPermissions.practiceLocations.selfDispensationStatus.url` (string) URL to the documentation of the Self Dispensation Status Technical Key. Example: "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/self_dispensation_status/url" - `businessPartners.profile.hcpProfile.operationalPermissions.practiceLocations.selfDispensationStatus.technicalKey` (string) Technical key of the self-dispensation status. Example: "NO" - `businessPartners.profile.hcpProfile.operationalPermissions.practiceLocations.controlledSubstancePurchasePermission` (object) The controlled substance purchase permission of the Healthcare Professional. - `businessPartners.profile.hcpProfile.operationalPermissions.practiceLocations.controlledSubstancePurchasePermission.name` (string) Name of the controlled substance purchase permission. Example: "Yes" - `businessPartners.profile.hcpProfile.operationalPermissions.practiceLocations.controlledSubstancePurchasePermission.url` (string) URL to the documentation of the Controlled Substance Purchase Permission Technical Key. Example: "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/controlled_substance_purchase_permission/url" - `businessPartners.profile.hcpProfile.operationalPermissions.practiceLocations.controlledSubstancePurchasePermission.technicalKey` (string) Technical key of the controlled substance purchase permission. Example: "YES" - `businessPartners.relations` (array) List of Relations. Insert or update Business Partner Relations. Relations that are not listed in the request and start in the current business partner, are marked as INACTIVE. In D&B storages, only not listed relations of class [D&B Hierarchy](https://meta.cdq.com/Business_partner/relation/class/dnb) and one of type [https://meta.cdq.com/Business_partner/relation/type/direct_legal_relation](Direct Legal Relation), [https://meta.cdq.com/Business_partner/relation/type/domestic_legal_ultimate_relation](Domestic Legal Ultimate Relation) or [https://meta.cdq.com/Business_partner/relation/type/global_legal_ultimate_relation](Global Legal Ultimate Relation), are marked as INACTIVE. - `businessPartners.relations.startedAt` (string) Describe when this relationship was first established. Example: "2025-09-10T10:12:36Z" - `businessPartners.relations.endedAt` (string) Describe when this relationship ended. Example: "2025-09-10T10:12:36Z" - `businessPartners.relations.type` (object) Provides information about the type of the relationship between two Business Partners like:\ direct parent/child, ultimate parent, branch. - `businessPartners.relations.type.name` (string) Display name of the Business Partner Relation Type. Example: "Commercial ultimate" - `businessPartners.relations.type.technicalKey` (string) Technical Key of the Business Partner Relation Type. Example: "COMMERCIAL_ULTIMATE" - `businessPartners.relations.type.url` (string) URL to the documentation which summarizes all details of a [Business Partner Relation Type](https://meta.cdq.com/Business_partner/relation/type). Example: "https://meta.cdq.com/Business_partner/relation/type" - `businessPartners.relations.class` (object) Provides information about the classification of the relation. - `businessPartners.relations.class.name` (string) Display name of the Business Partner Relation Class. Example: "CDQ Hierarchy" - `businessPartners.relations.class.technicalKey` (string) Technical Key of the Business Partner Relation Class. Example: "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY" - `businessPartners.relations.class.url` (string) URL to the documentation which summarizes all details of a [Business Partner Relation Class](https://meta.cdq.com/Business_partner/relation/class). Example: "https://meta.cdq.com/Business_partner/relation/class" - `businessPartners.relations.startNode` (object) Unique identifiers for Business Partner in the relation - `businessPartners.relations.startNode.dataSourceId` (string) Unique identifier for a Data Source of the Storage. Example: "648824a691d8d2503d65103e" - `businessPartners.relations.endNode` (object) Unique identifiers for Business Partner in the relation - `businessPartners.relations.deactivatedAt` (string) Describe when this relationship was deactivated. Read only. Example: "2025-09-10T10:12:36Z" - `businessPartners.types` (array) List of Types. - `businessPartners.types.name` (string) Display name of the Business Partner Type Name. Example: "Legal Entity" - `businessPartners.types.url` (string) URL to the documentation which summarizes all details of a [Buisness Partner Type](https://meta.cdq.com/Business_partner/type). Example: "https://meta.cdq.com/Business_partner/type" - `businessPartners.types.technicalKey` (string) Technical key of the Business Partner Type. Example: "LEGAL_ENTITY" - `businessPartners.addresses` (array) List of Addresses. - `businessPartners.addresses.id` (string) ID of the address. Example: "0001" - `businessPartners.addresses.externalId` (string) ID the address has in the external system where the record originates from. Example: "1" - `businessPartners.addresses.cdqId` (string) CDQ ID of an address. Example: "CDQID-123456789" - `businessPartners.addresses.version` (object) 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. - `businessPartners.addresses.version.characterSet` (object) Character set. Available values can be found [here](https://meta.cdq.com/Address/version/character_set). - `businessPartners.addresses.version.characterSet.name` (string) Name of character set. Supported character sets can be found [here](https://meta.cdq.com/Address/version/character_set). Example: "International" - `businessPartners.addresses.version.characterSet.technicalKey` (string) Technical key of character set. Supported character sets can be found [here](https://meta.cdq.com/Address/version/character_set). Example: "INTERNATIONAL" - `businessPartners.addresses.identifyingName` (object) An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent. - `businessPartners.addresses.identifyingName.value` (string) An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent. Example: "John Doe" - `businessPartners.addresses.careOf` (object) 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. - `businessPartners.addresses.careOf.value` (string) Value of the CareOf. Example: "CDQ GmbH c/o Product Department" - `businessPartners.addresses.contexts` (array) List of Address Contexts. - `businessPartners.addresses.contexts.value` (string) Value of the Address Context. Example: "Production hall 7, Storage field 8." - `businessPartners.addresses.administrativeAreas` (array) List of Administrative Areas. - `businessPartners.addresses.administrativeAreas.value` (string) Name of the [Administrative Area](https://meta.cdq.com/Address/administrative_area). Example: "Sankt Gallen" - `businessPartners.addresses.administrativeAreas.shortName` (string) Abbreviation for the [Administrative Area](https://meta.cdq.com/Address/administrative_area). Example: "SG" - `businessPartners.addresses.administrativeAreas.isoCode` (string) ISO 3166-2 code which uniquely defines the names of countries and their subdivisions (e.g., provinces or states). Example: "CH-SG" - `businessPartners.addresses.administrativeAreas.type` (object) Type of the [Administrative Area](https://meta.cdq.com/Address/administrative_area). - `businessPartners.addresses.administrativeAreas.type.name` (string) Display label for the Administrative Area Type. Example: "COUNTY" - `businessPartners.addresses.administrativeAreas.type.url` (string) URL to the documentation which summarizes all details of the [Administrative Area](https://meta.cdq.com/Address/administrative_area/type). Example: "https://meta.cdq.com/Address/administrative_area/type" - `businessPartners.addresses.administrativeAreas.type.technicalKey` (string) Technical key of the Administrative Area. Example: "COUNTY" - `businessPartners.addresses.postCodes` (array) List of Post Codes. - `businessPartners.addresses.postCodes.value` (string) Effective [post code](https://meta.cdq.com/Address/post_code). Example: "9000" - `businessPartners.addresses.postCodes.type` (object) A country specific code for a certain [address](https://meta.cdq.com/Address) component or a combination of [address](https://meta.cdq.com/Address) components, e.g. [locality](https://meta.cdq.com/Address/locality). - `businessPartners.addresses.postCodes.type.name` (string) Display label for the Post Code Type. Example: "Regular" - `businessPartners.addresses.postCodes.type.url` (string) URL to the documentation which summarizes all details of the [Administrative Area](https://meta.cdq.com/Address/post_code/type). Example: "https://meta.cdq.com/Address/post_code/type" - `businessPartners.addresses.postCodes.type.technicalKey` (string) Technical key of the Post Code. Example: "REGULAR" - `businessPartners.addresses.localities` (array) List of Localities. - `businessPartners.addresses.localities.type` (object) Type of the [Locality](https://meta.cdq.com/Address/locality). - `businessPartners.addresses.localities.type.name` (string) Display label for the Locality Type. Example: "City" - `businessPartners.addresses.localities.type.url` (string) URL to the documentation which summarizes all details of the [Locality Type](https://meta.cdq.com/Address/locality/type). Example: "https://meta.cdq.com/Address/locality/type" - `businessPartners.addresses.localities.type.technicalKey` (string) Technical Key of the Locality Type. Example: "CITY" - `businessPartners.addresses.localities.shortName` (string) Abbreviation of the [Locality](https://meta.cdq.com/Address/locality). Example: "St. Gallen" - `businessPartners.addresses.localities.value` (string) Name of the [Locality](https://meta.cdq.com/Address/locality). Example: "Sankt Gallen" - `businessPartners.addresses.thoroughfares` (array) List of Thoroughfares. - `businessPartners.addresses.thoroughfares.type` (object) Type of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). - `businessPartners.addresses.thoroughfares.type.name` (string) Display label for the Thoroughfare Type Name. Example: "Industrial zone" - `businessPartners.addresses.thoroughfares.type.url` (string) URL to the documentation which summarizes all details of the [Thoroughfare Type](https://meta.cdq.com/Address/thoroughfare/type). Example: "https://meta.cdq.com/Address/thoroughfare/type" - `businessPartners.addresses.thoroughfares.type.technicalKey` (string) Technical key of the Thoroughfare Type. Example: "INDUSTRIAL_ZONE" - `businessPartners.addresses.thoroughfares.shortName` (string) Abbreviation of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). Example: "Lukasstr. 4" - `businessPartners.addresses.thoroughfares.number` (string) Number of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). Example: "4" - `businessPartners.addresses.thoroughfares.value` (string) Comprehensive designation of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) including the thoroughfare type such as Street, or Rue. Example: "Lukasstraße 4" - `businessPartners.addresses.thoroughfares.name` (string) Pure name of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) not comprising the thoroughfare type such as Street, or Rue. Example: "Lukasstraße" - `businessPartners.addresses.thoroughfares.direction` (string) Direction of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). Example: "221-bis Baker Street, North" - `businessPartners.addresses.premises` (array) List of Premises. - `businessPartners.addresses.premises.value` (string) The actual value of a Premise in the language of the address. Example: "Lukasstraße 4" - `businessPartners.addresses.premises.shortName` (string) Abbreviation of the Premise. Example: "Lukasstr. 4" - `businessPartners.addresses.premises.number` (string) Number of the Premise. Example: "4" - `businessPartners.addresses.premises.type` (object) Type of the Premise. - `businessPartners.addresses.premises.type.name` (string) Display label for the Premise Type. Example: "Factory" - `businessPartners.addresses.premises.type.url` (string) URL to the documentation which summarizes all details of the [Premise Type](https://meta.cdq.com/Address/premise/type). Example: "https://meta.cdq.com/Address/premise/type" - `businessPartners.addresses.premises.type.technicalKey` (string) Technical key of the Premise Type. Example: "FACTORY" - `businessPartners.addresses.postalDeliveryPoints` (array) List of Postal Delivery Points. - `businessPartners.addresses.postalDeliveryPoints.type` (object) A single mailbox or other place at which postal mail is delivered. - `businessPartners.addresses.postalDeliveryPoints.type.name` (string) Display label for the Postal Delivery Point Type. Example: "Mailbox" - `businessPartners.addresses.postalDeliveryPoints.type.url` (string) URL to the documentation which summarizes all details of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point/type) Example: "https://meta.cdq.com/Address/postal_delivery_point/type" - `businessPartners.addresses.postalDeliveryPoints.type.technicalKey` (string) Technical key of the Postal Delivery Point. Example: "MAILBOX" - `businessPartners.addresses.postalDeliveryPoints.shortName` (string) Stort name of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point). Example: "St Gallen, Postfach 460" - `businessPartners.addresses.postalDeliveryPoints.number` (string) Number of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point). Example: "460" - `businessPartners.addresses.postalDeliveryPoints.value` (string) Value of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point). Example: "Postfach" - `businessPartners.addresses.geographicCoordinates` (object) Decimal geographic coordinates (WGS 84 - reference coordinate system). - `businessPartners.addresses.geographicCoordinates.latitude` (number) Plain on the earth's surface north or south of the equator. Example: "47.439549" - `businessPartners.addresses.geographicCoordinates.longitude` (number) Plain on the earth's surface east or west of a meridian. Example: "9.395275" - `businessPartners.bankAccounts` (array) List of Bank Accounts. - `businessPartners.bankAccounts.internationalBankAccountIdentifier` (string) The IBAN of a bank account. Example: "CH8800781619278412000" - `businessPartners.bankAccounts.internationalBankIdentifier` (string) (BIC/SWIFT) Bank identifier which is globally unique. Example: "KBSGCH22XXX" - `businessPartners.bankAccounts.nationalBankAccountIdentifier` (string) Identifier of a bank account in a national context, i.e. for a country. Example: "619278412000" - `businessPartners.bankAccounts.nationalBankIdentifier` (string) Bank identifier which is unique in a national context, i.e. for a country. Example: "00781" - `businessPartners.bankAccounts.countryCode` (string) ISO code to identify the country a bank account is registered in. Example: "DE" - `businessPartners.bankAccounts.vendorPaymentSummary` (object) Vendor Payment Summary. - `businessPartners.bankAccounts.vendorPaymentSummary.firstPaymentDate` (string) The date of the first payment to the bank account (ISO 8601-compliant). Example: "2025-09-10T10:12:36Z" - `businessPartners.bankAccounts.vendorPaymentSummary.lastPaymentDate` (string) The date of the last payment to the bank account (ISO 8601-compliant). Example: "2025-09-10T10:12:36Z" - `businessPartners.bankAccounts.vendorPaymentSummary.numberOfPayments` (integer) The number of payments to the bank account. Example: "1" - `businessPartners.externalContext` (object) Represents additional context information that is external to the main Business Partner data. - `featuresOn` (array) Features to be activated during the upsert. Enum: "UPSERT_BY_EXTERNAL_ID", "API_ERROR_ON_FAILURES", "LAB_USE_QUEUES", "TRANSFORM_RECORD", "ENABLE_SETTINGS", "ENABLE_ASYNC" - `featuresOff` (array) Features to be deactivated during the upsert. Enum: "UPSERT_BY_EXTERNAL_ID", "API_ERROR_ON_FAILURES", "LAB_USE_QUEUES", "TRANSFORM_RECORD", "ENABLE_SETTINGS", "ENABLE_ASYNC" ## Response 200 fields (application/json): - `numberOfAccepted` (integer) When asynchronous processing activated (ENABLE_ASYNC or LAB_USE_QUEUES), then represents number of Business Partners to be processed asynchronously. When synchronous processing activated, then provides number of Business Partners processed. Example: "10" - `numberOfFailed` (integer) Number of failed inserts. Example: "10" - `failures` (array) List of failures. - `failures.id` (string) ID of a failed upsert. Example: "567326478287468742" - `failures.externalId` (string) ID of the failed upsert in the external system where the record originates from. Example: "LFA1.1234567" - `failures.message` (string) Message displayed in the failure log. Example: "This record could not be stored due to timeout." - `featuresOn` (array) List of features that cna be activated during the upsert. Example: ["UPSERT_BY_EXTERNAL_ID"]