bird verify verifications
Usage
Exemplo de código
bird verify verificationsDescription
Start a verification (send a passcode) and check a submitted code. A create is
also the resend: starting again for the same recipient re-sends the code after the
resend cooldown rather than opening a second verification.
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. 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
- 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.