bird verify verifications
Usage
Code example
bird verify verificationsDescription
A create is also the resend: starting again for the same recipient re-sends the code after
the cooldown rather than opening a second verification. A check is identified by that same
recipient, since no verification id is stored. When the code never arrives, next-channel
sends a fresh one on the next channel.
Mutations take flags and/or a --body-file JSON body (flags overriding); run --example to print the body shape or --dry-run to preview the request.
Procedure
Verify a recipient with a one-time passcode
Start a verification to send a passcode to a phone (over SMS) or an email address (over email), then check the code the recipient submits. Identify the check by the same recipient used to start it — no verification id is stored. When the recipient says nothing arrived, advance to the next channel in the plan instead of resending on the same one. SMS delivery draws on the workspace's SMS balance.
- bird verify verifications create — Sends the passcode and returns the verification in pending; the passcode is never returned. Starting again for the same recipient re-sends the code after the resend cooldown rather than opening a second verification. Next: bird verify verifications check or bird verify verifications next-channel
- bird verify verifications check — Returns success: true when the code matches. A wrong or expired code returns success: false with a reason, not an error; only a missing verification (including one already resolved, which is no longer checkable), malformed input, or rate limiting is an error.
- bird verify verifications next-channel — Sends a fresh passcode on the next channel in the plan, keyed by the same recipient. Unlike starting again, it skips the resend cooldown and moves channel rather than repeating the current one; every passcode already sent stays valid, and last_channel names the channel used. Next: bird verify verifications check
Commands
| Name | Description |
|---|---|
| check | Check a passcode a recipient submitted for their verification |
| create | Start a verification and send a one-time passcode to a recipient |
| next-channel | Send a fresh passcode on the next channel, for a recipient who never received it |