VTEX · Authentication Profile

Vtex Authentication

Authentication

VTEX secures its APIs with apiKey and http across 8 declared security schemes, as derived from its OpenAPI definitions.

CommerceE-CommerceRetailMarketplacePayments
Methods: apiKey, http Schemes: 8 OAuth flows: API key in: cookie, header

Security Schemes

VtexIdclientAutCookie apiKey
· in: header (VtexIdclientAutCookie)
appKey apiKey
· in: header (X-VTEX-API-AppKey)
appToken apiKey
· in: header (X-VTEX-API-AppToken)
appKey apiKey
· in: header (X-PROVIDER-API-AppKey)
appToken apiKey
· in: header (X-PROVIDER-API-AppToken)
vtex_session apiKey
· in: cookie (vtex_session)
vtex_segment apiKey
· in: cookie (vtex_segment)
Authorization http
scheme: bearer

Source

Authentication Profile

Raw ↑ 
generated: '2026-07-11'
method: derived
source: openapi/vtex-anti-fraud-provider-openapi-original.yml, openapi/vtex-buyer-organization-openapi-original.yml,
  openapi/vtex-catalog-api-seller-portal-openapi-original.yml, openapi/vtex-checkout-openapi-original.yml,
  openapi/vtex-customer-credit-openapi-original.yml, openapi/vtex-data-subject-rights-openapi-original.yml,
  openapi/vtex-do-openapi-original.yml, openapi/vtex-gift-card-hub-openapi-original.yml, openapi/vtex-gift-card-openapi-original.yml,
  openapi/vtex-gift-card-provider-protocol-openapi-original.yml, openapi/vtex-id-openapi-original.yml,
  openapi/vtex-legacy-cms-portal-openapi-original.yml ...
summary:
  types:
  - apiKey
  - http
  api_key_in:
  - cookie
  - header
schemes:
- name: VtexIdclientAutCookie
  type: apiKey
  in: header
  parameter: VtexIdclientAutCookie
  description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens),
    valid for 24 hours.'
  sources:
  - openapi/vtex-anti-fraud-provider-openapi-original.yml
  - openapi/vtex-buyer-organization-openapi-original.yml
  - openapi/vtex-catalog-api-seller-portal-openapi-original.yml
  - openapi/vtex-checkout-openapi-original.yml
  - openapi/vtex-customer-credit-openapi-original.yml
  - openapi/vtex-data-subject-rights-openapi-original.yml
  - openapi/vtex-gift-card-hub-openapi-original.yml
  - openapi/vtex-gift-card-openapi-original.yml
  - openapi/vtex-id-openapi-original.yml
  - openapi/vtex-legacy-cms-portal-openapi-original.yml
  - openapi/vtex-license-manager-openapi-original.yml
  - openapi/vtex-marketplace-openapi-original.yml
  - openapi/vtex-marketplace-protocol-external-seller-marketplace-openapi-original.yml
  - openapi/vtex-master-data-openapi-original.yml
  - openapi/vtex-orders-pii-openapi-original.yml
  - openapi/vtex-payment-provider-protocol-openapi-original.yml
  - openapi/vtex-payments-gateway-openapi-original.yml
  - openapi/vtex-policies-system-openapi-original.yml
  - openapi/vtex-pricing-hub-openapi-original.yml
  - openapi/vtex-pricing-openapi-original.yml
  - openapi/vtex-profile-system-openapi-original.yml
  - openapi/vtex-promotions-taxes-openapi-original.yml
  - openapi/vtex-reviews-ratings-openapi-original.yml
  - openapi/vtex-shipping-network-openapi-original.yml
- name: appKey
  type: apiKey
  in: header
  parameter: X-VTEX-API-AppKey
  description: Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
  sources:
  - openapi/vtex-buyer-organization-openapi-original.yml
  - openapi/vtex-catalog-api-seller-portal-openapi-original.yml
  - openapi/vtex-checkout-openapi-original.yml
  - openapi/vtex-customer-credit-openapi-original.yml
  - openapi/vtex-data-subject-rights-openapi-original.yml
  - openapi/vtex-do-openapi-original.yml
  - openapi/vtex-gift-card-hub-openapi-original.yml
  - openapi/vtex-gift-card-openapi-original.yml
  - openapi/vtex-id-openapi-original.yml
  - openapi/vtex-legacy-cms-portal-openapi-original.yml
  - openapi/vtex-legacy-search-openapi-original.yml
  - openapi/vtex-license-manager-openapi-original.yml
  - openapi/vtex-logistics-openapi-original.yml
  - openapi/vtex-marketplace-openapi-original.yml
  - openapi/vtex-marketplace-protocol-external-mapper-openapi-original.yml
  - openapi/vtex-marketplace-protocol-external-orders-openapi-original.yml
  - openapi/vtex-marketplace-protocol-external-seller-fulfillment-openapi-original.yml
  - openapi/vtex-marketplace-protocol-external-seller-marketplace-openapi-original.yml
  - openapi/vtex-master-data-openapi-original.yml
  - openapi/vtex-message-center-openapi-original.yml
  - openapi/vtex-orders-openapi-original.yml
  - openapi/vtex-orders-pii-openapi-original.yml
  - openapi/vtex-payment-provider-protocol-openapi-original.yml
  - openapi/vtex-payments-gateway-openapi-original.yml
  - openapi/vtex-policies-system-openapi-original.yml
  - openapi/vtex-pricing-hub-openapi-original.yml
  - openapi/vtex-pricing-openapi-original.yml
  - openapi/vtex-profile-system-openapi-original.yml
  - openapi/vtex-promotions-taxes-openapi-original.yml
  - openapi/vtex-reviews-ratings-openapi-original.yml
  - openapi/vtex-sent-offers-openapi-original.yml
  - openapi/vtex-shipping-network-openapi-original.yml
  - openapi/vtex-sku-bindings-openapi-original.yml
  - openapi/vtex-subscriptions-openapi-original.yml
- name: appToken
  type: apiKey
  in: header
  parameter: X-VTEX-API-AppToken
  description: Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
  sources:
  - openapi/vtex-buyer-organization-openapi-original.yml
  - openapi/vtex-catalog-api-seller-portal-openapi-original.yml
  - openapi/vtex-checkout-openapi-original.yml
  - openapi/vtex-customer-credit-openapi-original.yml
  - openapi/vtex-data-subject-rights-openapi-original.yml
  - openapi/vtex-do-openapi-original.yml
  - openapi/vtex-gift-card-hub-openapi-original.yml
  - openapi/vtex-gift-card-openapi-original.yml
  - openapi/vtex-id-openapi-original.yml
  - openapi/vtex-legacy-cms-portal-openapi-original.yml
  - openapi/vtex-legacy-search-openapi-original.yml
  - openapi/vtex-license-manager-openapi-original.yml
  - openapi/vtex-logistics-openapi-original.yml
  - openapi/vtex-marketplace-openapi-original.yml
  - openapi/vtex-marketplace-protocol-external-mapper-openapi-original.yml
  - openapi/vtex-marketplace-protocol-external-orders-openapi-original.yml
  - openapi/vtex-marketplace-protocol-external-seller-fulfillment-openapi-original.yml
  - openapi/vtex-marketplace-protocol-external-seller-marketplace-openapi-original.yml
  - openapi/vtex-master-data-openapi-original.yml
  - openapi/vtex-message-center-openapi-original.yml
  - openapi/vtex-orders-openapi-original.yml
  - openapi/vtex-orders-pii-openapi-original.yml
  - openapi/vtex-payment-provider-protocol-openapi-original.yml
  - openapi/vtex-payments-gateway-openapi-original.yml
  - openapi/vtex-policies-system-openapi-original.yml
  - openapi/vtex-pricing-hub-openapi-original.yml
  - openapi/vtex-pricing-openapi-original.yml
  - openapi/vtex-profile-system-openapi-original.yml
  - openapi/vtex-promotions-taxes-openapi-original.yml
  - openapi/vtex-reviews-ratings-openapi-original.yml
  - openapi/vtex-sent-offers-openapi-original.yml
  - openapi/vtex-shipping-network-openapi-original.yml
  - openapi/vtex-sku-bindings-openapi-original.yml
  - openapi/vtex-subscriptions-openapi-original.yml
- name: appKey
  type: apiKey
  in: header
  parameter: X-PROVIDER-API-AppKey
  description: Unique identifier created by the provider and configured through [Giftcard Hub
    API](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#put-/api/giftcardproviders/-giftCardProviderId-).
  sources:
  - openapi/vtex-gift-card-provider-protocol-openapi-original.yml
- name: appToken
  type: apiKey
  in: header
  parameter: X-PROVIDER-API-AppToken
  description: Unique token created by the provider and configured through [Giftcard Hub API](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#put-/api/giftcardproviders/-giftCardProviderId-).
  sources:
  - openapi/vtex-gift-card-provider-protocol-openapi-original.yml
- name: vtex_session
  type: apiKey
  in: cookie
  parameter: vtex_session
  description: Token that identifies the user's individual session. Obtained [when a new session
    is created](https://developers.vtex.com/docs/api-reference/session-manager-api#post-/api/sessions).
  sources:
  - openapi/vtex-sessions-openapi-original.yml
- name: vtex_segment
  type: apiKey
  in: cookie
  parameter: vtex_segment
  description: Token that identifies the user's segment, shared with other users with similar
    navigation parameters. Obtained [when a new session is created](https://developers.vtex.com/docs/api-reference/session-manager-api#post-/api/sessions).
  sources:
  - openapi/vtex-sessions-openapi-original.yml
- name: Authorization
  type: http
  scheme: bearer
  description: To use the endpoints, please login through the Authentication API, and copy the
    access token in the response.
  sources:
  - openapi/vtex-tracking-openapi-original.yml