Claim (/v1/claim/verify)

Code verified; the user was joined to the brand’s WorkOS organization and the brand marked claimed.

POST /v1/claim/verify

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/claim/verify' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "[e-mail]",
  "code": "string"
}'

200

{
  "ok": true,
  "brand": {
    "slug": "acme-outdoors",
    "display_name": "Ada Lovelace"
  },
  "login_url": "string"
}

Request body

object

email · string · required

code · string · required

Magic Auth code from the email

Response

object

ok · boolean · required

brand · object · required

Show brand

slug · string · required

display_name · string · required

login_url · string · required

Dashboard login URL for the claimed brand

Status codes

Code	Meaning
200	Code verified; the user was joined to the brand’s WorkOS organization and the brand marked claimed.
400	Validation error
401	Unauthorized
404	Not found
429	Rate limited
500	Internal error

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/claim/verify' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "[e-mail]",
  "code": "string"
}'

200

{
  "ok": true,
  "brand": {
    "slug": "acme-outdoors",
    "display_name": "Ada Lovelace"
  },
  "login_url": "string"
}