Mailing Address
The mailingAddress
payload records the account holder's physical mailing address details. This information is essential for ensuring accurate correspondence and meeting regulatory requirements that mandate a physical address.
Payload Structure with Validation Rules
- Schema
- Example
Field Name | Type | Description | Validations | Values Accepted |
---|---|---|---|---|
country | String | The country of the mailing address. | Required field with a valid 2-character country code. | Countries |
street | String | The street address, including house number and street name. | Required field without special characters. | a-Z, 0-9, #, / |
city | String | The city of the mailing address. | Required field without numeric or special characters. | a-Z, #, / |
stateProvince | String | The state or province of the mailing address. | Required field with a valid 2-character US state/province code. | US States |
postalCode | String | The postal or ZIP code of the mailing address. | Required field with a valid 5-digit US ZIP. | Exact 5 digits |
{
"mailingAddress": {
"country": "US",
"street": "1549 Scott Center Rd",
"city": "Sherman",
"stateProvince": "AL",
"postalCode": "14781"
}
}
Any validation failure will trigger an error message and halt the Account Creation or Updation Process.
Error Scenarios
For any validation failures, refer Standard Errors and Account Related Errors.