POST/api/v2/users/account-claim/challenges/verify

Verifies the emailed code and returns the company-scoped Hoppa identity exactly once.

Authentication

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

Request body

application/json

Request body fields
FieldTypeRequiredDescription
ChallengeIdstring (uuid)Yes
CodestringYes

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
UserIdunknownYes
EmailstringYes
FirstNamestringYes
LastNamestringYes
AccountTypestringYes
StatusstringYes

400 — Bad Request

Response 400 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

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/verify" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ChallengeId":"…","Code":"…"}'

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