Documentation

App Development

Storefront Development

Troubleshooting

API Reference

Filter By

Post

Get

Put

Delete

Patch

VTEX ID

VTEX ID API provides endpoints to manage user authentication in your VTEX store. Check the Authentication guide for more information.

Index

Storefront users

POST Create storefront user with username: Registers a new storefront user in VTEX ID using a unique login key (username).
GET Get storefront user by identifier: Fetches a storefront user by their identifier (username or email).

Authentication

POST Generate authentication token
POST Check authenticated user
POST Enable or disable repeated passwords
POST Expire user password
GET Get user ID by email

Token renewal

PATCH Initiate token renewal
PATCH Complete token renewal

Refresh token (Headless)

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
Create storefront user	POST	`/api/authenticator/storefront/users`
Get storefront user by identifier	GET	`/api/vtexid/pvt/user/info`

Loading API specification...