Address Migration API¶

Following Vietnam's administrative reform and provincial mergers, VIETMAP provides comprehensive Address Migration APIs to help developers transition from old administrative divisions to new ones seamlessly. These APIs ensure your applications can handle both legacy and current address formats during the transition period.
Problems Solved¶
Vietnam's recent administrative reforms have created significant challenges for businesses and developers:
- Data Inconsistency: Existing databases contain addresses using old administrative divisions
- Search Confusion: Users may search using either old or new address formats
- System Integration: Applications need to handle both legacy and current address structures
- Business Continuity: Companies need seamless transition without service interruption
- Compliance Requirements: Government and enterprise systems must adapt to new official boundaries
Overview¶
The Address Migration API suite includes four main functionalities to address these challenges:
- V4 Address Search - Response both old and new address formats in one response
- Address Conversion - Convert old addresses to new administrative format
- Legacy Address Search - Search using old administrative divisions
- New Address Search - Search using new administrative divisions
- Hybrid Address Search - Search across both old and new address formats, response as input format
Autocomplete V4 docs - Geocoder V4 docs
Contact for API Access¶
To request access and obtain API endpoints:
- Register an API Key: here
For any inquiries or support:
-
Zalo OA: Vietmap Solutions
-
Email: maps.info@vietmap.vn
-
Website: https://maps.vietmap.vn
1. V4 Address Search¶
Purpose: Search across both old and new address formats simultaneously, providing comprehensive coverage during transition period.
Use Cases:
-
On going transition support, where users may input either old or new address formats, and the system needs to return results in both formats for clarity, we provide V4 Address Search API that returns both old and new address formats in one response.
-
User-friendly applications that allow users to search using familiar address formats, regardless of the administrative changes.
Documentation:
Detailed documentation for V4 Address Search API can be found here: - Autocomplete V4 - Search/Geocoding V4.
Demo:
Try this API on our live map here
2. Address Conversion¶
Purpose: Convert addresses from old administrative divisions to new administrative format in batch operations.
Use Cases:
- Migration of existing address databases to new formats, ensuring data consistency across systems.
- Updating user profiles, delivery addresses, and location data in applications to reflect new administrative boundaries.
- Compliance with government regulations requiring the use of updated address formats.
Documentation:
Detailed documentation for Address Conversion API can be found here.
Demo:
Try this API on our conversation tool here
3. Legacy Address Search¶
Purpose: Enable searching for addresses using the old administrative division structure (before provincial merger).
Use Cases:
- Legacy system integration
- Historical data retrieval
Key Features:
- Maintains compatibility with existing address databases
- Supports proximity-based search with GPS coordinates
- Filters by data types (POI, ADDRESS, VILLAGE, WARD, DISTRICT, CITY, STREET)
- Returns detailed boundary information for old administrative divisions
- Provides match confidence scoring
Example Scenarios:
- A logistics company needs to find delivery addresses stored in their old system
- Government agencies accessing historical records with legacy administrative references
- Real estate platforms supporting property searches using familiar old address formats
4. Current Address Search¶
Purpose: Search for addresses using the new administrative division structure (after provincial merger).
Use Cases:
- New system development
- Official government compliance
- Updated mapping applications
- Current administrative operations
Key Features:
- Aligned with latest administrative boundaries
- Enhanced accuracy for current geographic divisions
- Support for new administrative entities
- Integration with official government databases
- Real-time boundary validation
Example Scenarios:
- E-commerce platforms updating delivery zones
- Banking systems updating branch locations for regulatory compliance
- Emergency services routing using current administrative boundaries
5. Hybrid Address Search¶
Purpose: Search across both old and new address formats simultaneously, providing comprehensive coverage during transition period.
Use Cases:
- Transition period support
- User-friendly applications
- Comprehensive data coverage
- Flexible search capabilities
Key Features:
- Intelligent format detection
- Preference settings for result prioritization
- Cross-reference between old and new formats
- Migration status tracking
- Unified result format
Example Scenarios:
- A mobile app allowing users to search using either "Bình Dương" or "Thành phố Hồ Chí Minh" formats
- Customer service systems handling inquiries with mixed address formats
- Navigation apps supporting both legacy and current address inputs
6. V4 Address Search¶
Purpose: Response both old and new address formats in one response.
Use Cases:
- Transition period support
- User-friendly applications
- Comprehensive data coverage
- Flexible search capabilities
Key Features:
- Response both old and new address formats in one response
- Support for multiple input formats
- Cross-reference between old and new formats
- Educate users after migration
Example Scenarios:
- A mobile app allowing users to search using either "Bình Dương" or "Thành phố Hồ Chí Minh" formats
- Customer service systems handling inquiries with mixed address formats
- Navigation apps supporting both legacy and current address inputs
- Output both old and new address formats in one response, helping users get familiar with new address formats and not feel confused during the transition period
Technical Benefits¶
Performance Optimization¶
- Intelligent Caching: Optimized caching strategies for frequently accessed addresses
- Batch Processing: Efficient handling of large-scale address migrations
- Load Balancing: Distributed processing for high-volume requests
Data Quality Assurance¶
- Confidence Scoring: Each result includes accuracy metrics
- Validation Levels: Configurable strictness for different use cases
- Error Handling: Comprehensive error reporting and fallback strategies
Integration Flexibility¶
- RESTful APIs: Standard HTTP methods for easy integration
- Multiple Response Formats: JSON with detailed metadata
- Rate Limiting: Tiered access levels for different business needs
Business Impact¶
Cost Reduction¶
- Minimize Manual Updates: Automated conversion reduces manual data entry
- Prevent Service Disruptions: Seamless transition without downtime
- Reduce Support Tickets: Unified search reduces user confusion
Compliance & Accuracy¶
- Government Compliance: Alignment with official administrative changes
- Data Standardization: Consistent address formats across systems
- Audit Trail: Complete tracking of address changes
User Experience¶
- Flexible Search: Users can search using familiar address formats
- Faster Results: Optimized search algorithms for quick responses
- Progressive Migration: Gradual transition without forcing immediate changes
Request API Access¶
To get started with Address Migration APIs:
Contact Information:
-
Zalo OA: Vietmap Solutions
-
Email: maps.info@vietmap.vn
-
Website: https://maps.vietmap.vn
Our team will provide:
- Custom API endpoints for your use case
- Technical documentation and integration guide
- Implementation support and consultation
- Testing environment access
- Production deployment assistance