SUsupabase
auth

Authenticate a user by sending them a One-Time Password over email or SMS.

Changed on
post/otp

Request

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

Request body

emailstring email
phonestring phone
channel'sms' | 'whatsapp'
create_userboolean
dataobject
code_challenge_method's256' | 'plain'
code_challengestring

Response

A One-Time Password was sent to the email or phone. To obfuscate whether such an address or number already exists in the system this response is sent in both cases.

message_idstring

Unique ID of the message as reported by the SMS sending provider. Useful for tracking deliverability problems.

Changes

  • 4d0f1a6c1ad9Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 77f9aeb9339aRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status