ClientMergedV1v1.0.0
Holds information about when a client is merged when duplicate client records found in Operational Data store. This
event will include all the documents attached to this client
When firing this event make sure you set the `correlationId` in the headers. Our schemas have standard metadata make sure you read and follow it.
Details
This event can only be triggered once when a Client merged in Operational data store.
Consumer / Producer Diagram
ClientMergedV1 Schema (json)
{
"$id": "https://example.com/ClientMergedV1.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ClientMergedV1",
"description": "An event raised when a client is merged",
"type": "object",
"properties": {
"metadata": {
"type": "object",
"properties": {
"occurredAtUtc": {
"type": "string",
"description": "The date and time when event occurred in UTC. Date should be represented in ISO 8601 format e.g 2023-09-08T12:00:00Z"
},
"typeName": {
"type": "string",
"description": "The name of the event. E.g ClientMergedV1"
},
"source": {
"type": "string",
"description": "The source of the event like was it genereated by Client using Web or WeChat"
},
"applicationBreadcrumb": {
"type": "string",
"description": "Th application path which is describing the chain of applications. For e.g my-christies-web-ui;3.0.1:follows-api;v1.1.0"
},
"version":{
"type": "string",
"description": "The version of the message in semantic versioning format ideally V{major.minor.patch}. E.g V1.0.0 or just V{majorVersion}"
},
"sentAtUtc": {
"type": "string",
"description": "When event was sent by the publishers in ISO 8601 "
},
"isTransactionalAccountAvailableForClient": {
"type": "boolean",
"description": "Indicates if the transaction account for a client is available"
},
"required": [ "occurredAtUtc", "typeName", "sentAtUtc", "version", "isTransactionalAccountAvailableForClient"]
}
},
"data": {
"type": "object",
"properties": {
"loserClient": {
"type": "object",
"properties": {
"globalClientId": {
"type": "string",
"description": "The GUID of the client which is being merged"
},
"clientNumber": {
"type": "number",
"description": "The CRM number of the client which is being merged"
},
"type": {
"type": "string",
"description": "The type of client, e.g. Person or Organisation"
}
}
},
"survivorClient": {
"type": "object",
"properties": {
"globalClientId": {
"type": "string",
"description": "The GUID of the client which is the winner in the merge"
},
"clientNumber": {
"type": "number",
"description": "The CRM number of the client which is the winner in the merge"
},
"type": {
"type": "string",
"description": "The type of client, e.g. Person or Organisation"
}
}
},
"survivorClientDetails":{
"type": "object",
"properties": {
"globalClientId": {
"type": "string",
"description": "The GUID of client"
},
"clientNumber": {
"type": "number",
"description": "The CRM number of the client"
},
"type": {
"type": "string",
"description": "The type of client. Allowed Values are Person or Organisation"
},
"title": {
"type": "string",
"description": "Client title, e.g. Mr, Mrs, Ms"
},
"firstName": {
"type": "string",
"description": "Client first name"
},
"middleName": {
"type": "string",
"description": "Client middle name"
},
"lastName": {
"type": "string",
"description": "Client last name"
},
"nameSuffix": {
"type": "string",
"description": "Client name suffix, e.g. Jr, Sr"
},
"fullName": {
"type": "string",
"description": "Client full name, e.g. Mr John Smith"
},
"fullNameAlias": {
"type": "string",
"description": "The alias of the client full name"
},
"kycStatus": {
"type": "string",
"description": "The KYC (Know Your Customer) status of the client. Allowed Values: Awaiting Corporate Documents, Awaiting Photo ID, Awaiting Proof of Address, Completed, KYC Required, Pre-2009"
},
"grade":{
"type": "string",
"description": "The grade of the client. Allowed Values: 1, 2, 3. Values description 1- Platinum, 2-Gold, 3-Silver"
},
"source":{
"type": "string",
"description": "The source from which the client was created. For e.g Media article, eComm, Website etc"
},
"category":{
"type": "string",
"description": "The category of the client. Allowed Values: Trade, Staff, Private, Press, Institution, Expert, Estate, Corporate Collector, Adviser"
},
"status":{
"type": "string",
"description": "The status of the client. Allowed Values: Archive, Current Transactor, Deceased & Archive, Deceased, Defunct & Archive, Defunct, Historic Transactor, Lapsed Transactor, Non-Transacting Client, Prospective Client"
},
"dateOfBirthDay": {
"type": "number",
"description": "The day of birth of the client"
},
"dateOfBirthMonth": {
"type": "number",
"description": "The month of birth of the client"
},
"dateOfBirthYear": {
"type": "number",
"description": "The year of birth of the client"
},
"dateOfDeathDay": {
"type": "number",
"description": "The day of death of the client"
},
"dateOfDeathMonth": {
"type": "number",
"description": "The month of death of the client"
},
"dateOfDeathYear": {
"type": "number",
"description": "The year of death of the client"
},
"alternativeLanguage": {
"type": "object",
"properties": {
"languageName": {
"type": "string",
"description": "The alternative language code of the client"
},
"title": {
"type": "string",
"description": "The alternative language description of the client"
},
"firstName": {
"type": "string",
"description": "The alternative language first name of the client"
},
"middleName": {
"type": "string",
"description": "The alternative language middle name of the client"
},
"lastName": {
"type": "string",
"description": "The alternative language last name of the client"
},
"fullName": {
"type": "string",
"description": "The alternative language full name of the client"
}
}
},
"preferredLanguage": {
"type": "string",
"description": "The preferred language of the client"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"globalClientEmailId": {
"type": "string",
"description": "The GUID of the email of the client"
},
"address": {
"type": "string",
"description": "The email address of the client"
},
"status": {
"type": "string",
"description": "The status of the email address. Allowed values: Current, Do not use, Incorrect, Old"
}
}
}
},
"addresses" : {
"type": "array",
"items": {
"type": "object",
"properties": {
"globalClientAddressId": {
"type": "string",
"description": "The GUID of the address of the client"
},
"addressNumber": {
"type": "number",
"description": "The address number of the client"
},
"mailingNameLine1": {
"type": "string",
"description": "First line of the mailing name"
},
"mailingNameLine2": {
"type": "string",
"description": "Second line of the mailing name"
},
"line1": {
"type": "string",
"description": "First line of the address"
},
"line2": {
"type": "string",
"description": "Second line of the address"
},
"line3": {
"type": "string",
"description": "Third line of the address"
},
"city": {
"type": "string",
"description": "City of the address"
},
"state": {
"type": "string",
"description": "State"
},
"county": {
"type": "string",
"description": "County name"
},
"postalCode": {
"type": "string",
"description": "Postal code"
},
"country": {
"type": "string",
"description": "Country"
},
"status": {
"type": "string",
"description": "Address Status. Allowed values: Current, Do Not Use, Incorrect, Old"
},
"type": {
"type": "string",
"description": "Address Type. Allowed values: Business, Holiday Home, Home, Other Home, Registered, Residential, Temporary"
},
"alternativeLanguageAddress":{
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "Alternative language"
},
"mailingNameLine1": {
"type": "string",
"description": "First line of the mailing name in alternative language"
},
"mailingNameLine2": {
"type": "string",
"description": "Second line of the mailing name in alternative language"
},
"line1": {
"type": "string",
"description": "First line of the address in alternative language"
},
"line2": {
"type": "string",
"description": "Second line of the address in alternative language"
},
"line3": {
"type": "string",
"description": "Third line of the address in alternative language"
},
"city": {
"type": "string",
"description": "City in alternative language"
},
"state": {
"type": "string",
"description": "State in alternative language"
},
"county": {
"type": "string",
"description": "County in alternative language"
},
"postalCode": {
"type": "string",
"description": "Postal code in alternative language"
},
"country": {
"type": "string",
"description": "Country in alternative language"
}
}
}
}
}
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"globalClientPhoneId": {
"type": "string",
"description": "The GUID of the email of the client"
},
"diallingCode": {
"type": "integer",
"description": "Dialling code identifier for e.g. 44 for UK, 1 for US"
},
"phoneNumber": {
"type": "string",
"description": "Phone number"
},
"extension": {
"type": "string",
"description": "Phone extension"
},
"areaCode": {
"type": "string",
"description": "Area code"
},
"localNumber": {
"type": "string",
"description": "Local number"
},
"status": {
"type": "string",
"description": "Phone status. Allowed values: Current, Do not use, Incorrect, Old"
},
"type": {
"type": "string",
"description": "Phone type. Allowed values: Assistant, Business, Fax, Home, Mobile/Cell, Other, Other Home, Temporary"
},
"medium": {
"type": "string",
"description": "Phone medium. Allowed values: Fax, Mobile/Cell, Landline, VOIP"
}
}
}
},
"kycDocuments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identityReferenceNumber":{
"type" : "string",
"description": "The identity reference number of KYC document."
},
"country" : {
"type" : "string",
"description": "The country of issuance of KYC document."
},
"type": {
"type": "string",
"description": "Allowed values Passport, Driving License, National ID card and Other"
},
"expiryAt": {
"type": "string",
"description": "The expiry date of KYC document in ISO 8601 format e.g 2023-09-08"
},
"effectiveAt":{
"type": "string",
"description": "The effective date of KYC document in ISO 8601 format e.g 2023-09-08"
},
"isPrimary":{
"type": "boolean",
"description": "Indicates if this is the primary KYC document for the client"
}
}
}
},
"taxDocuments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type":{
"type" : "string",
"description": "Allowed values W-9, W-8BEN, W-8BEN-E, W-8ECI, W-8EXP, W-8IMY, DAC7."
},
"referenceNumber" : {
"type" : "string",
"description": "The tax reference number of the client"
},
"documentStatus": {
"type" : "string",
"description" : "Allowed values Active and Inactive"
},
"federalTaxClassification": {
"type": "string",
"description": "Federal tax classification. Allowed values: C Corporation, Individual, Individual/single-member LLC, Individual/sole proprietor, LLC/C-Corporation, LLC/P-Partnership, LLC/S-Corporation, Other, Partnership, S Corporation, Trust/Estate"
},
"country" : {
"type": "string",
"description": "Tax country"
},
"identificationNumberType": {
"type": "string",
"description": "Allowed values EIN, SSN"
},
"documentExpireAt": {
"type": "date",
"description": "Expiry date of the tax document"
}
}
}
},
"transactionalAccounts":{
"type": "array",
"items": {
"type": "object",
"properties": {
"globalTransactionAccountId": {
"type": "string",
"description": "The GUID of the transaction account"
},
"accountNumber": {
"type": "string",
"description": "The account number of the transaction account"
},
"accountName": {
"type": "string",
"description": "The name of the transaction account"
},
"alternativeLanguage": {
"type": "string",
"description": "The alternative language name of the transaction account"
},
"alternativeLanguageAccountName": {
"type": "string",
"description": "The alternative language name of the transaction account"
},
"status": {
"type": "string",
"description": "The status of the transaction account, e.g. Active, Inactive"
},
"primaryAddresses":{
"type": "object",
"properties":{
"transactionalAccount":{
"type": "object",
"properties": {
"globalClientAddressId": {
"type": "string"
},
"addressNumber": {
"type": "string"
}
},
"invoiceAddress": {
"type": "object",
"properties": {
"globalClientAddressId": {
"type": "string"
},
"addressNumber": {
"type": "string"
}
}
},
"shipping": {
"type": "object",
"properties": {
"globalClientAddressId": {
"type": "string"
},
"addressNumber": {
"type": "string"
}
}
},
"wineDelivery": {
"type": "object",
"properties": {
"globalClientAddressId": {
"type": "string"
},
"addressNumber": {
"type": "string"
}
}
}
}
}
},
"transactionAccountAssociatedAddresses": {
"type": "array",
"description": "The associated addresses linked to the transaction account",
"items": {
"type": "object",
"properties": {
"addressNumber": {
"type": "string",
"description": "The address number associated with the transaction account"
},
"globalClientAddressId": {
"type": "string",
"description": "The GUID of the address associated with the transaction account"
}
}
}
},
"restrictions": {
"type": "array",
"description": "The restrictions associated with the transaction account",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of restriction added to the transaction account. Allowed values are 01, 03, 06, 11, 02, 04, 05. The values descriptions 01-Account Full Restriction, 03-No Bidding, 06-No Payment, 11-No Collection, 02-No Consigning, 04-Consignment Warning, 05-Bidding Warning"
},
"reason": {
"type": "string",
"description": "The reason for the restriction on the transaction account. Allowed values are AA, A, CO, CR, FR, KYC, L, O, R, ST. The values descriptions are AA-Abuse of Account, A-Anti-Money Laundering, CO-Commercial Office, CR-Credit, FR-Fraud, KYC-Know Your Client, L-Legal, O-Other, R-Restitution, ST-Settlements."
},
"status": {
"type": "string",
"description": "The status of the restriction on the transaction account. Allowed values Active,Removed."
},
"placedOn": {
"type": "string",
"description": "The date and time when the restriction was placed on the transaction account"
},
"confidentialNote": {
"type": "string",
"description": "Any confidential note regarding the restriction"
},
"nonConfidentialNote": {
"type": "string",
"description": "Any non-confidential note regarding the restriction"
}
}
}
},
"authorisedUsers": {
"type": "array",
"description": "The authorised users linked to the transaction account",
"items": {
"type": "object",
"properties": {
"client": {
"type": "object",
"properties": {
"globalClientId": {
"type": "string",
"description": "The GUID of client"
},
"clientNumber": {
"type": "number",
"description": "The CRM number of the client"
},
"type": {
"type": "string",
"description": "The type of client, e.g. Person or Organisation"
},
"fullName": {
"type": "string",
"description": "The full name of the client"
}
}
},
"type": {
"type": "string",
"description": "Authorised user type. Allowed values: AU-All: Bid, Collect, AU-One Sale: One Off, AU-Only Bidding, AU-Only Collecting, Account Holder, Created in Error."
},
"level": {
"type": "string",
"description": "The level of the authorised user. Allowed values 0, 1, 2. Values description 0- Standard Authorised User, 1- Authorised User Plus, 2- Super Authorised User"
},
"startAt": {
"type": "string",
"description": "The start date and time of the authorised user in ISO 8601 format"
},
"expiryAt": {
"type": "string",
"description": "The expiry date and time of the authorised user in ISO 8601 format"
}
}
}
},
"taxCountry": {
"type": "string",
"description": "The country of the transaction account for tax purposes"
},
"taxNumber": {
"type": "string",
"description": "The tax number associated with the transaction account"
},
"hongKongConsignmentTaxStatus": {
"type": "boolean",
"description": "Indicates if the transaction account is subject to Hong Kong consignment tax"
},
"hongKongConsignmentTaxDate": {
"type": "string",
"format": "date-time",
"description": "The date when the Hong Kong consignment tax was applied"
},
"termsType": {
"type": "string",
"description": "The type of terms associated with the transaction account, e.g. Standard, Special"
},
"termsBuyerDays": {
"type": "number",
"description": "The number of days for buyer terms associated with the transaction account"
},
"termsSellerDays": {
"type": "number",
"description": "The number of days for seller terms associated with the transaction account"
},
"aicDealType":{
"type": "string",
"description": "The type of AIC deal associated with the transaction account, e.g. Standard, Special"
},
"aicRecipientType": {
"type": "string",
"description": "The type of recipient for AIC deals associated with the transaction account, e.g. Buyer, Seller"
},
"aicDealStartOn": {
"type": "string",
"format": "date-time",
"description": "The start date of the AIC deal associated with the transaction account"
},
"aicDealEndOn": {
"type": "string",
"format": "date-time",
"description": "The end date of the AIC deal associated with the transaction account"
},
"vatCountry": {
"type": "string",
"description": "The country of the transaction account for VAT purposes"
},
"vatNumber": {
"type": "string",
"description": "The VAT number associated with the transaction account"
},
"sellerVatStatus": {
"type": "boolean",
"description": "Indicates if the transaction account is a seller VAT account"
},
"isBuyerMarginScheme": {
"type": "boolean",
"description": "Indicates if the transaction account is a buyer margin scheme account"
},
"isSellerMarginScheme": {
"type": "boolean",
"description": "Indicates if the transaction account is a seller margin scheme account"
},
"isEuConsumerRightDirective": {
"type": "boolean",
"description": "Indicates if the transaction account is subject to the EU Consumer Rights Directive"
}
}
}
},
"primaryAddress":{
"type": "object",
"properties": {
"globalClientAddressId": {
"type": "string",
"description": "The GUID of the address of the client"
},
"addressNumber": {
"type": "number",
"description": "The address number of the client"
}
}
},
"primaryEmail": {
"type": "object",
"properties": {
"globalClientEmailId": {
"type": "string",
"description": "The GUID of the email of the client"
}
}
},
"primaryPhone": {
"type": "object",
"properties": {
"globalClientPhoneId": {
"type": "string",
"description": "The GUID of the email of the client"
}
}
},
"marketingPreferences":{
"type": "object",
"properties": {
"emailAuctionUpdates": {
"type": "string",
"description": "Indicates if the client wants to receive email updates about auctions.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"emailEventInvitations": {
"type": "string",
"description": "Indicates if the client wants to receive email invitations to events.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"emailConsignmentValuationOpportunities": {
"type": "string",
"description": "Indicates if the client wants to receive email opportunities for consignment valuations.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"emailArtNews": {
"type": "string",
"description": "Indicates if the client wants to receive email updates about art news.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"emailLotAlerts": {
"type": "string",
"description": "Indicates if the client wants to receive email alerts about lots.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"emailMarketResearch": {
"type": "string",
"description": "Indicates if the client wants to receive email updates for market research.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"emailChristiesEducation": {
"type": "string",
"description": "Indicates if the client wants to receive email updates about Christie's education.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"emailChristiesRealEstate": {
"type": "string",
"description": "Indicates if the client wants to receive email updates about Christie's real estate.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"directMailAuctionUpdates": {
"type": "string",
"description": "Indicates if the client wants to receive direct mail updates about auctions.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"directMailEventInvitations": {
"type": "string",
"description": "Indicates if the client wants to receive direct mail invitations to events.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"directMailConsignmentValuationOpportunities": {
"type": "string",
"description": "Indicates if the client wants to receive direct mail opportunities for consignment valuations.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"directMailArtNews": {
"type": "string",
"description": "Indicates if the client wants to receive direct mail updates about art news.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"directMailPromotionalCatalogues": {
"type": "string",
"description": "Indicates if the client wants to receive direct mail promotional catalogues.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"directMailActivityCategoryTransactorCatalogues": {
"type": "string",
"description": "Indicates if the client wants to receive direct mail activity category transactor catalogues.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"directMailChristiesEducation": {
"type": "string",
"description": "Indicates if the client wants to receive direct mail updates about Christie's education.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
},
"directMailChristiesRealEstate": {
"type": "string",
"description": "Indicates if the client wants to receive direct mail updates about Christie's real estate.Allowed values I, O and U. I-Included, O-Opted out, U-Unknown"
}
}
}
}
}
}
}
}
}
Edit this pageLast updated on 2026/1/30