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, --email, or both. A phone number is verified over the phone channels configured for its country, in that country's order; an email address over email. 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 3 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 for a phone recipient
bird verify verifications create --phone-number +15551234567

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

# attach a correlation key
bird verify verifications create --phone-number +15551234567 --metadata '{"order_id":"123"}'

Options

Recipient

Name	Description
--email	Recipient email address (verified over email)
--phone-number	Recipient phone number in E.164 format, e.g. +15551234567 (verified over its country's phone channels)

Labels & metadata

Name	Description
--metadata	Arbitrary JSON metadata object

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. whatsapp,sms,telegram); 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
bird verify verifications next-channel	Send a fresh passcode on the next channel, for a recipient who never received it

Gerelateerde bronnen

Ga verder met de documentatie, gidsen en voorbeelden voor dit onderwerp. De bronnen zijn in het Engels.

Bekijk de gidsVerify phone numbers at signup Begrijp het conceptWhat does OTP mean? One-time passwords explained Ontdek de mogelijkheidCustomer verification Volg het leerpadBuild your first integration

Probeer de oefening en ontvang een implementatieoverzicht