bird verify verifications create

Usage

Codevoorbeeld

bird verify verifications create [flags]

Description

Start a verification and send a one-time passcode to a recipient.

Provide the recipient with --phone-number (SMS), --email-address (email), or both. Starting a verification for a recipient who already has one in progress re-sends the code after the resend cooldown rather than opening a second — this command is also the resend. The passcode is never returned; submit the recipient's entry with "bird verify verifications check".

Build the request from flags, a JSON VerificationCreateRequest body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Procedure

Step 1 of 2 of "Verify a recipient with a one-time passcode". Next: bird verify verifications check.

Examples

Codevoorbeeld

# print the body shape (no credentials needed)
bird verify verifications create --example

# the body it prints:

Codevoorbeeld

{
  "metadata": {
    "correlation_id": "signup-7f3a"
  },
  "to": {
    "phone_number": "+15551234567"
  }
}

Codevoorbeeld

# start over SMS
bird verify verifications create --phone-number +15551234567

# force channel order and a 6-digit code
bird verify verifications create --email-address user@example.com --channels email,sms --code-length 6

# attach metadata via a body file
bird verify verifications create --phone-number +15551234567 --body-file body.json

Options

Recipient

Name	Description
--email-address	Recipient email address (verified over email)
--phone-number	Recipient phone number in E.164 format, e.g. +15551234567 (verified over SMS)

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--code-length <n>	Passcode length for this verification (4–8), overriding the configured length
--channels <v1,v2,…>	Delivery channels to try, in order (e.g. sms,email); omit for the configured order
--response-schema	Print the fields this command returns, then exit

Name	Description
bird verify verifications check	Check a passcode a recipient submitted for their verification.