API Reference

Request a VERIFY OTP

post
https://auth.staging.hay.co/verifyemail

Note: Normally, a VERIFY OTP is included in the Magic Link sent to the app user via email. This is not convenient in automated testing scenarios. This endpoint allows to request the VERIFY OTP and receive it in an immediate HTTP response.

This endpoint is only available in Staging, for emails that have been registered to enable this functionality (on request).

Body Params

Request to send a Magic Link email to a specified address.

string
required
length ≥ 1

Email to send the Magic Link to

string
required
length between 0 and 256

The challenge

string
required
length ≥ 1
^sign-up$|^login$|^reset$

State, which identifies the journey related to this request. Allowed values:

  • sign-up for sign-up journey
  • login for login journey
  • reset for passcode reset journey
string

Request source (client reference, e.g. haas4)

Responses
200

Success

400

Bad Request

500

Internal error

Updated 3 months ago

Did this page help you?
Language
LoadingLoading…

Updated 3 months ago

Did this page help you?