HEhexclave
Password

Sign up with email and password

Changed on

Create a new account with email and password

post/auth/password/sign-up

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/auth/password/sign-up
  • Auth
    none declared

Request body

emailstring required

The email to sign in with.

passwordstring required
verification_callback_urlstring

The base callback URL to construct a verification link for the verification e-mail. A query parameter code with the verification code will be appended to it. The page should then make a request to the /contact-channels/verify endpoint.

bot_challenge_tokenstring
bot_challenge_phase'invisible' | 'visible'
bot_challenge_unavailable'true'

Example request

{
  "email": "johndoe@example.com",
  "verification_callback_url": "https://example.com/handler/email-verification"
}

Response

Successful response

access_tokenstring required
refresh_tokenstring required
user_idstring required

Changes

  • 180fda38d099Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • info

      added the new invisible enum value to the request property

    • info

      added the new true enum value to the request property

    • info

      added the new visible enum value to the request property

  • 9025167b1683Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property