Current Address

1.4.5 Current Address

Event notification for amendment in current address details of the party.

An event is published for an amendment in current address details data segment. This event encompasses modifications such as addition, deletion, modification of current addresses.

The current address data segment supports amendments via both PUT and PATCH API methods. When employing the PATCH API method for amendments, event publishing will be contingent on the information provided in the request and will solely include the attributes that have been modified.

The PATCH API method, an HTTP request method, is utilized for field-level modifications within a Data Segment of customer information, rather than updating the entire Data Segment Information. Through the PATCH Method, specific fields can be added, updated, or deleted at the Data Segment level by specifying the attributes requiring modification.

recordStat field in the event identifies the nature of amendment as:

"U" - Update to an existing record.
"I" - Insert of a new record.
"D" - Delete of an existing record.

Table 1-7 Data Segment

Data Segment Code	Data Segment Name	Topic Name	Party Type
DS0005	CURRENT_ADDRESS	obpyRetAmendCurrentAddr	Retail

Event Payload

{
         “applicationNumber”: “string”,
         “branchCode”: “000”,  
         “userId”: “string”,   
         “partyId”: “string”, 
         “externalCustomerId”: “string”,
         “partyType”: “I”,   
         “eventType”: “AMEND”, 
         “handoffStatus”: “SUCCESS”, 
         “sourceProductId”: “OBPY”, 
         “datasegmentCode”: “DS0005”, 
         “datasegmentName”: “CURRENT_ADDRESS”,
         “httpMethod”: “PUT”,
         “amendPayload”: 
          “{\”recordId\”: \”string\”, \”parentId\”: \”string\”, \”partyId\”:
          \”string\”, \”versionNo\”: 2, \”recordStat\”: \”O\”, \”createdBy\”:
          \”string\”, \”createdDate\”: \”2020-03-26T12:57:21\”, \”updatedBy\”:
          \”string\”, \”updatedDate\”: \”2020-03-26T12:57:21\”,
          \”partyContactDetailsList\”: [{\”id\”: \”string\”, \”addressType\”: \”C\”,
          \”buildingName\”: \”string\”, \”streetName\”: \”string\”, \”city\”:
          \”string\”, \”state\”: \”string\”, \”country\”: \”US\”, \”zipCode\”:
          \”string\”, \”addressSource\”: \”RES\”, \”mobileNumber\”: \”string\”,
          \”officialNumber\”: \”string\”, \”mobileNumberIsd\”: \”string\”,
          \”officialNumberIsd\”: \”string\”, \”emailId\”: \”string\”, \”createdBy\”:
          \”string\”, \”createdDate\”: \”2020-03-26T12:56:35\”, \”updatedBy\”:
          \”string\”, \”updatedDate\”: \”2020-03-26T12:56:35\”, \”recordStat\”:
          \”O\”, \”versionNo\”: 1, \”parentId\”: \”string\”, \”location\”:
          \”GB\”, \”preferred\”: true, \”currentAddress\”: true, \”addressFrom\”:
          \”2018-03-02\”, \”partyMediaContactDetails\”: []}], \”links\”: []}”,
         “amendDateTime”: “2024-09-12T07:35:19.931327”,   
         “applicationDate”: “2020-03-26”  
          }

Parent topic: Retail Party Amendment