Skip to content

POST /v3/auth/email-check

POST
/v3/auth/email-check
curl --request POST \
--url https://api-ha-prod-p8.handbid.dev/v3/auth/email-check \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: */*' \
--data '"{\n \"email\": \"user@example.com\",\n \"whitelabelId\": {{whitelabelId}}\n}"'

Checks whether an account exists for the given email.

Next step after this runs:

  • userFound: true → run verify-pin (the SMS PIN was just fired to the user’s phone on file).
  • userFound: false → run register (then verify-pin).

Before you send: edit the body to use a real email. The default user@example.com is a placeholder and will always return userFound: false — not a bug. Real seeded test users in local dev: dev@handbid.com, jhporte@handbid.com, *@handbid.dev.

reCAPTCHA: captchaToken is optional (action login). When present it’s validated against the endpoint-appropriate site-key. When absent, the request is routed through a strict rate-limit budget instead (10 req / 5 min per IP) — you’ll get a 429 rate_limited with retryAfter: 300 if you burn through the budget. In docker-dev both validation and the strict throttle are skipped because params['captchaOnRegisterEnabled'] is false.

Media type */*
string
Example
"{\n \"email\": \"user@example.com\",\n \"whitelabelId\": {{whitelabelId}}\n}"

Successful response

Media type application/json