post https://api.banking.netevia.dev/api/account/changeAddressOtp
This API endpoint allows personal customers to update their residential or mailing address by providing a one-time password (OTP). It's designed specifically for individual users (personal customers) to ensure that their address information is accurate and up-to-date in the system.
Body Parameters:
- streetAddress (string, required):
The new street address for the personal customer. The format should be "123 Avenue Street". The length must be at least 1 character.
Example: "456 Elm Street". - extendedAddress (string, optional):
Any additional address information, such as apartment number or suite.
Example: "Apt 5B". - postalCode (string, required):
The postal code corresponding to the new address. The length must be at least 1 character.
Example: "10001". - city (string, required):
The city of the new address. The length must be at least 1 character.
Example: "New York". - state (int32, required):
The state or region code for the new address. This must be provided as an integer representing the state.
Example: 1. - oneTimeCode (string, required):
The one-time password (OTP) for verifying the user's identity and authorizing the address change. The length must be at least 1 character.
Example: "789456". - secureOperationType (string, required):
Specifies the type of secure operation. For changing the address, this value should be "ShortMessageCode", ensuring the operation is secured.
Use Case:
- Address Update:
This API is used by personal customers to update their street address, postal code, city, and state in the system. - Improved Security:
Requiring an OTP ensures that only the account holder can make changes to their address information, enhancing security and preventing unauthorized updates.
Summary:
The POST /api/account/changeAddressOtp API allows personal customers to securely update their residential or mailing address by verifying their identity through OTP. This ensures that the customer's contact information is kept accurate and secure for communication and account management.