Skip to main contentOverview
The Addresses API provides functionality for managing addresses for various entities (users, customers, companies). It supports:
- Multiple address types (registration, actual, operational, correspondence, billing)
- Primary address designation
- Country and postal code validation
- RBAC-based access control
Core Concepts
Address Types
- Registration Address: Official registered address for legal purposes
- Actual Address: Physical location where an entity is located
- Operational Address: Where operations are conducted (multiple allowed)
- Correspondence Address: Where mail should be sent
- Billing Address: For invoices and financial documents
Record Types
Different entity types can have different address requirements:
- Customer: All address types allowed
- User: Only actual and correspondence addresses
- Company: All address types allowed
Validation Rules
Postal Code
- Minimum 3 characters
- Maximum 10 characters
- Alphanumeric with optional spaces and hyphens
Street
- Required
- Maximum 255 characters
City
- Required
- Maximum 100 characters
Country
- Required
- ISO 2-letter code
- Must be valid country code
