VTEX ID
VTEX ID API provides endpoints to manage user authentication in your VTEX store. Check the Authentication guide for more information.
This API does not serve stores using B2B Buyer Portal. For storefront user registration and B2B password migration configuration, see the Authenticator API and the B2B user provisioning and B2B password migration guides.
Endpoints
Authentication
| Summary | Method | Path |
|---|---|---|
| Generate authentication token | POST | /api/vtexid/apptoken/login |
| Exchange OAuth access token for VTEX credential | POST | /api/vtexid/audience/webstore/provider/oauth/exchange |
| Check authenticated user | POST | /api/vtexid/credential/validate |
| Enable or disable repeated passwords | POST | /api/vtexid/pub/providers/setup/password/webstore/password |
| Expire user password | POST | /api/vtexid/password/expire |
| Get user ID by email | GET | /api/vtexid/pvt/user/id |
Token renewal
| Summary | Method | Path |
|---|---|---|
| Initiate token renewal | PATCH | /api/vtexid/apikey/{apiKey}/apitoken/renew |
| Complete token renewal | PATCH | /api/vtexid/apikey/{apiKey}/apitoken/finish-renewal |
Refresh token headless
| Summary | Method | Path |
|---|---|---|
| Start authentication | GET | /api/vtexid/pub/authentication/start |
| Send access key | POST | /api/vtexid/pub/authentication/accesskey/send |
| Validate session | POST | /api/vtexid/pub/authentication/accesskey/validate |
| Refresh token | POST | /api/vtexid/refreshtoken/webstore |
Storefront users
| Summary | Method | Path |
|---|---|---|
| Get storefront user by identifier | GET | /api/vtexid/pvt/user/info |
Organization account authentication
| Summary | Method | Path |
|---|---|---|
| Get organization unit authentication settings | GET | /api/vtexid/organization-units/{unitId}/settings |
| Set organization unit authentication settings | POST | /api/vtexid/organization-units/{unitId}/settings |
| Update organization unit authentication settings | PATCH | /api/vtexid/organization-units/{unitId}/settings |
| Delete organization unit authentication setting | DELETE | /api/vtexid/organization-units/{unitId}/settings |