Use Cases and Examples
Use Cases
The end user wants to update/modify their primary contact information so that they can log into the online application with updated mobile number, postal address or email ID. In this scenario, the end user is the customer of a financial institution.
- Update the primary contact information for the given institution user using the specified update method: (PUT /customers/{customerId}:contact-info).
- Retrieve the existing phone number and postal address for the given institutionId, customerId and userIdType (CUSTOMER_ID, LOGIN_ID).
- The Update Contact Endpoint allows customer to update the email address or phone number or the postal address.
- If the customer is updating the phone number, the ‘oldPhoneNumber’ field is required and must match the previous phone number.
- If the endpoint includes a postal address, phone number and email address objects in the request, all three fields will get updated with the provided values.
Sample Code
Here is the standard flow for updating the contact information :
-
Customer should make an Update Contact Info Method request to update their contact information (PUT /customers/{customerId}:contact-info).
-
Based on the input, either the email address or the phone number will get updated.
Sample JSON Request
{
"userIdType": "CUSTOMER_ID",
"phoneNumber": {
"oldPhoneNumber": "1234567890",
"oldCountryCode": "1",
"newPhoneNumber": "9999999999",
"newCountryCode": "1"
},
"email": {
"emailAddress": "jane.doe@gm.com"
},
"postalAddress": {
"address1": "main street",
"address2": "main street",
"city": "bangalore",
"state": "karnataka",
"postalCode": "89000",
"country": "IN"
}
}
-
Upon success in both the scenarios, a 204 response will be returned.
