bird verify verifications check

Usage

Przykład kodu

bird verify verifications check <code> [flags]

Description

Check a passcode a recipient submitted for their verification.

Identify the verification by the same recipient it was started for (--phone-number and/or --email-address); no verification id is needed. A wrong, expired, or used code is reported in the result with "success": false and a "reason" — it is not an error.

Build the request from the <code> argument and flags, a JSON VerificationCheckRequest body via --body-file ("-" reads stdin), or both — an inline value 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 2 of 2 of "Verify a recipient with a one-time passcode". Previous: bird verify verifications create.

Examples

Przykład kodu

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

# the body it prints:

Przykład kodu

{
  "code": "123456",
  "to": {
    "phone_number": "+15551234567"
  }
}

Przykład kodu

# check a code sent over SMS
bird verify verifications check 123456 --phone-number +15551234567

Options

Recipient

Name	Description
--email-address	Recipient email address the verification was started for
--phone-number	Recipient phone number (E.164) the verification was started for

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
--response-schema	Print the fields this command returns, then exit

Name	Description
bird verify verifications create	Start a verification and send a one-time passcode to a recipient.