B2B Password Migration Protocol

The B2B Password Migration Protocol is a set of definitions to help you integrate your legacy authentication system with VTEX's B2B user migration flow. This protocol defines the endpoints that your middleware must implement to enable B2B password migration. Your middleware must provide a client registration endpoint and an authentication endpoint that VTEX will call during the migration process.

To learn more about B2B password migration, check the B2B password migration guide.

This feature is only available for stores using B2B Buyer Portal, which is currently available to selected accounts.

Requirements

• The middleware endpoint must use a standard subdomain or domain name, not an IP address.
• All endpoints must be served over HTTPS on port 443 with TLS 1.3.
• TLS certificates must be valid and issued by a trusted Certificate Authority (CA).
• Endpoints must respond within 3 seconds (p95≤ 1s, p99 ≤ 2.5s recommended).
• Never log the Secret, passwords, or signatures.
• Do not reuse secrets across environments (e.g., staging vs. production).