SUsupabase
auth

Authenticate by verifying the possession of a one-time token.

Changed on
post/verify

Request

  • Base URL
    https://abcdefghijklmnopqrst.supabase.co/auth/v1
  • URL
    https://abcdefghijklmnopqrst.supabase.co/auth/v1/verify
  • Auth
    API key in header apikey

Request body

type'signup' | 'recovery' | 'invite' | 'magiclink' | 'email_change' | 'sms' | 'phone_change'
tokenstring
token_hashstring

The hashed value of token. Applicable only if used with type and nothing else.

emailstring email

Applicable only if type is with regards to an email address.

phonestring phone

Applicable only if type is with regards to an phone number.

redirect_tostring uri

(Optional) URL to redirect back into the app on after verification completes successfully. If not specified will use the "Site URL" configuration option. If not allowed per the allow list it will use the "Site URL" configuration option.

Response

An access and refresh token.

access_tokenstring

A valid JWT that will expire in expires_in seconds.

refresh_tokenstring

An opaque string that can be used once to obtain a new access and refresh token.

token_typestring

What type of token this is. Only bearer returned, may change in the future.

expires_ininteger

Number of seconds after which the access_token should be renewed by using the refresh token with the refresh_token grant type.

expires_atinteger

UNIX timestamp after which the access_token should be renewed by using the refresh token with the refresh_token grant type.

Changes

  • a222d9459767Revision changes
    • warning

      removed the optional property /// from the response with the status

    • info

      added the optional property /// to the response with the status

  • 4d0f1a6c1ad9Revision changes
    • breaking

      the /// response's property type changed from jsonb to string for status