Redeem an email verification link and sign in (ACCT-2)
The token is the `token` query parameter of the emailed link. A first verification creates the account and its personal household (HH-1) if the email is admitted (allowlist, pending invite, or existing member; HH-7, ACCT-4); otherwise the email is verified but the answer is 403 `not_invited`. 410 `invalid_link` for expired or used links. No authentication needed.
The token is the token query parameter of the emailed link. A first verification creates
the account and its personal household (HH-1) if the email is admitted (allowlist, pending
invite, or existing member; HH-7, ACCT-4); otherwise the email is verified but the answer is
403 not_invited. 410 invalid_link for expired or used links.
No authentication needed.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/auth/password/verify" \ -H "Content-Type: application/json" \ -d '{ "token": "string", "client": "web" }'{ "token": "string", "me": { "user": { "id": "string", "email": "string", "name": "string" }, "household": { "id": "01J8Z3N4Q5R6S7T8V9W0X1Y2Z3", "name": "string", "role": "owner" }, "default_household_id": "01J8Z3N4Q5R6S7T8V9W0X1Y2Z3", "households": [ { "id": "01J8Z3N4Q5R6S7T8V9W0X1Y2Z3", "name": "string", "role": "owner", "personal": true, "default": true, "archived": true, "member_count": 0, "joined_at": "2019-08-24T14:15:22Z" } ] }}Start an email + password sign-up (ACCT-1) POST
Emails a verification link (valid 24h, single use). If the email already belongs to an account, that inbox gets a "you already have an account" note instead. The response is the same either way. No authentication needed.
Email a new verification link to an unverified sign-up POST
No authentication needed.