H!HOPPA
POST/api/v2/users/account-claim/challenges

Sends a six-digit verification code when the email exactly matches a user in the API-key company.

The response is intentionally identical for known and unknown emails. The OTP is sent by Hoppa and is never returned by the API.

Authentication

Send your API key in the x-api-key header on every request.

Request body

application/json

Request body fields
FieldTypeRequiredDescription
EmailstringYes

Responses

202 — Accepted

Response 202 fields
FieldTypeRequiredDescription
ChallengeIdstring (uuid)Yes
ExpiresAtstring (date-time)Yes
MessagestringYes

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

429 — Too Many Requests

Response 429 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X POST "https://{base_url}/api/v2/users/account-claim/challenges" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"Email":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.