Employer Address
The employerAddress
refers to the official physical location of the employer of the user. It includes details such as the street address, city, state, postal code, and country. This information is required when the user provides employer details based on their occupation while registering the account for the primary owner.
Payload Structure with Validation Rules
- Schema
- Example
Field Name | Type | Description | Validations | Values Accepted |
---|---|---|---|---|
employerName | String | The name of the employer. | Required field without special characters if occupation is not 'Retired', 'Student' or empty. | a-Z, Maximum 40 characters |
employerPhoneNumber | String | The phone number of the employer. | Required field with numeric values. | Exact 10 digits |
employerAddress.street | String | The street of the employer. | Required field if occupation is not 'Retired', 'Student' or empty. | a-Z, 0-9, #, -, \, /, Maximum 160 characters |
employerAddress.city | String | The city of the employer. | Required field if occupation is not 'Retired', 'Student' or empty. | a-Z, 0-9, #, -, \, /, Maximum 20 characters |
employerAddress.stateProvince | String | The state province of the employer. | Required field if occupation is not 'Retired', 'Student' or empty. | US States |
employerAddress.postalCode | String | The postal code of the employer. | Required field if occupation is not 'Retired', 'Student' or empty. | a-Z, 0-9, -, Must be valid ZIP Code |
employerAddress.country | String | The country of the employer. | Required field if occupation is not 'Retired', 'Student' or empty. | US |
{
"employerName": "Abc consulting",
"employerPhoneNumber": "123",
"employerAddress": {
"street": "Employer Street",
"city": "Sherman1",
"stateProvince": "NY",
"postalCode": "12345",
"country": "US"
}
}
Note
employerName
not required to be specified if Joint owner role is Associate.
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.