Skip to content

docs: clarify verify endpoint payloads #2523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aqilaziz wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify verify endpoint payloads #2523

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1106,17 +1106,32 @@ Returns:

### **POST /verify**

Verify a registration or a password recovery. Type can be `signup`, `recovery`, `invite`, `magiclink`, `email_change`, `sms`, or `phone_change`
and the `token` is a token returned from either `/signup` or `/recover`.
Verify a registration, password recovery, magic link, email change, or phone
OTP. Type can be `signup`, `recovery`, `invite`, `magiclink`, `email`,
`email_change`, `sms`, or `phone_change`.

For a raw OTP code, send `token` with exactly one of `email` or `phone`.
Email-based verification types require `email`; phone-based verification types
(`sms` and `phone_change`) require `phone`.

```json
{
"type": "signup",
"token": "confirmation-code-delivered-in-email"
"token": "confirmation-code-delivered-in-email",
"email": "email@example.com"
}
```

`password` is required for signup verification if no existing password exists.
For email links that provide a token hash, send `token_hash` instead of
`token`. Do not include `email`, `phone`, or `redirect_to` when using
`token_hash`.

```json
{
"type": "signup",
"token_hash": "confirmation-token-hash-delivered-in-email-link"
}
```

Returns:

Expand Down