/
Contact usSee pricingStart building
    Introduction
    Overview
    Postman
    Users
      Create user
      Search users
      Get user
      Update user
      Exchange primary factor
    • Delete

      • Delete user
        Delete user email
        Delete user phone number
        Delete user WebAuthn registration
        Delete user biometric registration
        Delete user TOTP
        Delete user crypto wallet
        Delete user password
        Delete user OAuth registration
    Magic links
    • Via email

      • Send magic link
        Log in or create user
        Invite
        Revoke pending invite
    • Embeddable

      • Create
      Authenticate
    OAuth
      Attach
      Authenticate
    • Start

      • Google
        Amazon
        Apple
        Bitbucket
        Coinbase
        Discord
        Facebook
        Figma
        GitHub
        GitLab
        Linkedin
        Microsoft
        Salesforce
        Slack
        Snapchat
        TikTok
        Twitch
        Twitter
        Yahoo
    Passwords
      Create
      Authenticate
      Strength check
      Migrate
    • Reset options

      • Password reset by email start
        Password reset by email
        Password reset by existing password
        Password reset by session
    One-time passcodes (OTP)
    • Via SMS

      • Send
        Login or create user
    • Via Whatsapp

      • Send
        Login or create user
    • Via email

      • Send
        Login or create user
      Authenticate
    Session management
      Session object
      Get JWKS
      Get sessions
      Authenticate Session
      Revoke session
      Migrate session
      Attest Session
      Exchange Access Token
    Passkeys & WebAuthn
    • Register

      • Start
        Register
    • Authenticate

      • Start
        Authenticate
      Update
      List WebAuthn Credentials
    Time-based one-time passcodes (TOTP)
      Create
      Authenticate
      Get recovery codes
      Recover
    Crypto wallets
      Authenticate start
      Authenticate
    M2M Authentication
      M2M Client Object
    • Token

      • Get Access Token
        Authenticate Access Token
    • M2M Client

      • Create M2M client
        Get M2M client
        Search M2M clients
        Update M2M client
        Delete M2M client
    • Rotate secret

      • Start secret rotation
        Rotate secret
        Cancel secret rotation
    Connected Apps
      Exchange Authorization Code
      Exchange Refresh Token
    • Tokens

      • Connected App ID Token Object
        Connected App Access Token Object
    • Configuration

      • Get JWKS
        Get OpenID Configuration
    • Methods

      • Introspect Token
        Authenticate Access Token (Local)
        Revoke Token
        Get UserInfo
    • Consent Management

      • Start OAuth Authorization
        Submit OAuth Authorization
        Get Authorized Connected Apps for a User
        Revoke Connected App Access to a User
    • Application Management

      • Dynamic Client Registration
        Create Connected App
        Get Connected App
        Search Connected Apps
        Update Connected App
        Delete Connected App
    • Rotate secret

      • Start secret rotation
        Rotate secret
        Cancel secret rotation
    RBAC
      Resource object
      Role object
      Scope object
      Get RBAC Policy
    User Impersonation
      Authenticate Token
    Resources
      Email templates
      URL validation
      Metadata
      User states
    Errors
      Overview
      Error object
      400
      401
      403
      404
      405
      429
      499
      500
      503
Get support on SlackVisit our developer forum

Contact us

Consumer Authentication

/

API reference

/

Connected Apps

/

Exchange Refresh Token

Exchange Refresh Token for Access Token

POST
https://${projectDomain}/v1/oauth2/token

Exchange a refresh token for an access token for the given Connected Apps client. This endpoint uses your Custom Domain.

The refresh_token grant type is used to periodically exchange a refresh token for a new access token without user interaction. When using the refresh_token grant type, a refresh_token must be provided.

This endpoint returns different responses depending on the client being used and the scopes granted to that client:

  • If the openid scope has been granted, an id_token will be returned in the response.
  • If a First Party Public or Third Party Public client is used, the original refresh token sent in the request will be rotated out and a new refresh_token will be present in the response. You must save this new token for next time. Each refresh token has an expiry of 3 months from issuance.
  • If a First Party Confidential or Third Party Confidential client is used, no token rotation will occur. The refresh token used in the request will remain valid for future use and no new refresh_token will be present in the response. The refresh token has an initial expiry of 6 months, and each use extends its lifetime by another 3 months.

Connected App Access Tokens and ID Tokens are JWTs signed with the project's JWKS. ID Tokens are valid for one hour after issuance. Access Tokens expiry is controlled by the client's access_token_expiry_minutes field, which also defaults to one hour.

You can validate and examine your access and refresh tokens by using the Token Introspection Endpoint.

Access token JWTs can be validated locally by using a Stytch Backend SDK, or any library that supports the JWT protocol.

Important: Unlike other Stytch API endpoints, this endpoint is not authenticated with a project_id and project_secret pair. Instead, it is authenticated via the client_id and client_secret of an active Connected App Client within the current project.

This endpoint is an RFC-6749 compliant token issuing endpoint.

  • This endpoint supports passing the client_id and client_secret within the request body as well as within a HTTP-Basic Auth header.
  • This endpoint supports both application/json and application/x-www-form-urlencoded content types.

We recommend using the Custom Domain whenever possible. For backwards compatibiliy reasons, this endpoint is also available at https://test.stytch.com/v1/public/${projectId}/oauth2/token.


Body parameters


client_id* string

The ID of the Connected App client.


client_secret* string

The secret of the Connected App client. Required for confidential clients


grant_type* string

The OAuth2 defined grant type that should be used to acquire an access token. Either "authorization_code" or "refresh_token" is supported for Connected App clients. An error will be returned if this parameter is omitted.


refresh_token string

A refresh token previously issued to the client. This field is required when using the refresh_token grant.


Response fields


access_token string

The access token granted to the client. Access tokens are JWTs signed with the project's JWKs.


id_token string

An ID token containing information about the authenticated end-user. ID Tokens are JWTs signed with the project's JWKs. Only returned if the openid scope is granted.


refresh_token string

An opaque token that may be used in the future to retrieve a new access token. Only returned if the offline_access scope is granted.


token_type string

The type of the returned access token. Today, this value will always be equal to "bearer"


expires_in number

The lifetime in seconds of the access token. For example, the value 3600 denotes that the access token will expire in one hour from the time the response was generated.


request_id string

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.


status_code int

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

curl --request POST \
	--url https://${projectDomain}/v1/oauth2/token \
	-H 'Content-Type: application/json' \
	-d '{
		"client_id": "connected-app-test-d731954d-dab3-4a2b-bdee-07f3ad1be888",
		"client_secret": "NHQhc7ZqsXJVtgmN2MXr1etqsQrGAwJ-iBWNLKY7DzJq",
		"grant_type": "refresh_token",
		"refresh_token": "PvC5UudZ7TPZbELt95yXAQ-8MeEUCRob8bUQ-g52fIJs"
	}'
RESPONSE 200
200
​
{
  "access_token": "eyJ...",
  "expires_in": 3600,
  "refresh_token": "wUU...",
  "scope": "openid email profile phone",
  "token_type": "bearer",
  "id_token": "eyJ...",
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "status_code": 200
}
RESPONSE 404
200
​
{
  "status_code": 404,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "error_type": "idp_client_not_found",
  "error_message": "The IDP client requested could not be found.",
  "error_url": "https://stytch.com/docs/api/errors/404"
}
RESPONSE 429
200
​
{
  "status_code": 429,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "error_type": "too_many_requests",
  "error_message": "Too many requests have been made.",
  "error_url": "https://stytch.com/docs/api/errors/429"
}
RESPONSE 500
200
​
{
  "status_code": 500,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "error_type": "internal_server_error",
  "error_message": "Oops, something seems to have gone wrong, please reach out to support@stytch.com to let us know what went wrong.",
  "error_url": "https://stytch.com/docs/api/errors/500"
}