LogoLogo
No-code docsResources
  • 🖥️Welcome to the Bird API Docs
  • API Access
    • Access Policies
    • Access Roles
    • API Authorization
    • Common API usage
  • Conversations API
    • API reference
      • Channel configuration
        • Get conversations configuration
        • Update conversations configuration
      • Conversations messaging
        • Create conversation message
        • List conversation messages
        • Get conversation message
        • Update conversation message
        • Delete conversation message
        • Create pre-signed upload
      • Conversations management
        • Create conversation
        • List conversations
        • Get conversation
        • Update conversation
        • Delete conversation
      • Conversation Participants
        • Add participant to conversation
        • List participants
        • Get participant by ID
        • Get participant by identifier key and value
        • Update participant by ID
        • Update participant by identifier key and value
        • Delete participant
        • List participant conversations by ID
        • List participant conversations by identifier key and value
      • Workspace settings
        • Get antispam setting
        • Update antispam setting
        • Create allow/block rule
        • Get allow/block rule
        • List allow/block rules
        • Update allow/block rule
        • Delete allow/block rule
        • Add allow/block rules in bulk
        • Get allow/block bulk upload status
      • Events
  • Collaborations API
    • API reference
      • Agent Management
      • Team Management
      • Feeds
      • Feed item activity
      • Tags
      • Automation Rules
      • Business Hours
      • Capacity Rules
      • Routing Queues
      • Skills
      • SLA Policies
      • Macros
      • Sender Profiles
      • Ticket fields
  • Channels API
    • Supported channels
      • Programmable WhatsApp
        • Sending WhatsApp messages
        • Customer service window
        • Receiving messages
        • Message interactions
        • WhatsApp ISV integration
          • Setting up your customer workspaces
            • API Access
            • Associating your Facebook solution ID and business ID with your Bird CRM Organization
            • Creating a workspace for your customer
            • Buying a number through Bird
            • Subscribing to channel created webhooks
          • WhatsApp channel onboarding
            • Setting up the WhatsApp Embedded flow
            • Install WhatsApp phone number in Bird CRM
            • Subscribe to channel webhooks
      • Programmable SMS
        • Installing an SMS channel
          • US 10DLC API Installation
          • Toll-Free Numbers Verification API
        • Sending SMS messages
        • Receiving messages
        • Twilio Exit API
          • Using Twilio PHP SDK
          • Using Twilio Go SDK
          • Using Twilio Ruby SDK
        • Sinch Exit API
      • Programmable RCS
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Email
        • Sending Emails
        • Receiving messages
        • Message status
        • Message interactions
      • Programmable Line
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Telegram
        • Sending messages
        • Receiving messages
        • Message interactions
    • Message types
      • Text
      • Images
      • Files
      • List
      • Carousel
      • Template
    • Message status and interactions
      • Message Failure Codes
      • Message Failure Sources
        • SMS Platform Extended Error Codes
    • Send batch messages
    • API reference
      • Channel Groups
      • Messaging
      • Channels management
      • Channel connectors
      • Navigators
      • Compliance Keywords Messages
      • Conversions Sharing
      • Events
    • Rate Limit
  • Voice API
    • Installing a Voice channel
    • Voice Calls API
      • Initiate an outbound call
      • List calls from a channel
      • Get a call
      • Update a call
      • Answer a call
      • Ring a call
      • Hangup a call
      • Play a message in a call
      • Say Text-To-Speech (TTS)
      • Gather DTMF from a call
      • Forward a call
      • Record a Call
      • Record a call session
      • Update a call recording
      • List call recordings of a call
      • Get a call recording
      • Get a call insights
      • Get calls log
    • Recordings API
      • List Recordings
      • Get a Recording
      • Delete a Recording
      • List recording storage metrics
    • Transcriptions API
      • Initiate a Transcription
      • List Transcriptions
      • Get a Transcription
      • Delete a Transcription
    • Voice webhooks
    • Flash Calling API
  • Verify API
    • Verify API: Quick Start
  • Contacts API
    • Tracking Contact Events
      • API Reference
        • Get configuration
        • Track events
    • API reference
      • Manage workspace contacts
        • Create a contact
        • Get a contact
        • List contacts
        • Search contact by identifier
        • Update a contact
        • Create or update a contact by identifier
        • Delete a contact
      • Manage contact identifiers
        • Create contact identifier
        • List contact identifiers
        • Delete contact identifier
      • Manage contact attribute definition
        • Create attribute definition
        • Get attribute definition
        • List attribute definitions
      • Manage contact lists
        • Create a list
        • Get a list
        • List lists
        • Update a list
        • Delete a list
        • Add contacts to a list
        • Get contact list memberships
        • List contacts in a list
        • Remove contacts from a list
      • Lookup
        • Network/Country information for a phone number
  • Numbers API
    • API reference
      • Search Available Numbers
      • Buy a Number
      • List your Numbers
      • Get Long Code Number Details
      • Manage Endpoint Subscriptions
        • Cancel Number Subscription
      • Manage Endpoint Compliance Requirements
        • List Workspace compliace Requirements
        • Get Workspace Compliace Requirements
        • Update Workspace Compliace Requirements
      • 10DLC Compliance
        • Brands - Organization
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
        • Brands - workspace
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
          • List brand vettings
        • Campaigns
          • Optional: acting as Reseller
          • Create a campaign
          • List all campaigns
          • Get a campaign
          • Update a campaign
          • Delete a campaign
        • TCR Enums
        • Events
      • Toll-Free Numbers Verification API
      • Long Code Numbers
      • Short Code Numbers
      • Alphanumeric Senders
      • Events
  • Know-Your-Customer (KYC) API
    • List KYC forms
    • Get KYC form
    • Create KYC form entry
    • Update KYC form entry
    • List KYC form entries
    • Get a KYC form entry details
  • Reporting API
    • API reference
      • Channel Metrics
      • Flow Run Metrics
      • Wallet Metrics
      • Campaign Metrics
      • Message Metrics
  • Accounts API
    • API reference
      • Current user
        • Change password
        • Presigned upload
        • Memberships
        • Sessions
        • Configurations
          • Groups
            • Keys
      • IAM policies
      • Organizations
        • Upload media
        • Profile
        • Workspaces
        • Users
        • Access keys
        • Organization roles
        • Organization policies
        • Teams
          • Members
        • Approvals
          • Runs
            • Reviews
        • Configurations
          • Groups
            • Keys
      • Region groups
  • Touchpoints API
    • Supported Projects
      • Whatsapp Approved Message Templates
        • Creating WhatsApp Message templates
          • Text template blocks
          • Blocks Documentation
    • API reference
      • Projects
      • Message Templates
  • Notifications API
    • API Reference
      • Webhook subscriptions
        • Create a webhook subscription
        • List available webhook events
        • Get a webhook subscription
        • List webhook subscriptions
        • Update a webhook subscription
        • Delete a webhook subscription
        • Verifying a webhook subscription
        • Webhook subscription logs
  • Knowledge Base (KB) API
    • API reference
      • Documents
      • Folders
        • Import
      • Search
      • Presigned upload
  • Email API
    • Transmissions
    • Metrics
    • Events
    • SMTP API
  • Connectivity platform migration guide
    • Channels API and Conversations API
    • Migrating conversations API actions
    • Migrating WhatsApp channels
  • Client SDKs
    • Applications
    • Contact Profiles
      • Signed Identity
    • Push notifications
      • Quick Start
      • Subscribe contacts to push notification campaigns
      • Notification Display Priority
    • Event Tracking
      • Quick Start
      • Track Events
        • App
        • Audiences
        • Conference
        • Ecommerce
        • Hospitality
        • Lists
        • Messaging
        • Payments
        • Subscription
        • Suppressions
        • Survey
        • Web
    • App Inbox
      • Quick Start
      • Usage
      • Subscribe contacts to app inbox campaigns
    • SDK Integration
      • Android SDK
        • Notification Interactions
      • Swift SDK
        • Notification Interactions
      • Web SDK
        • Quick Start
        • Usage
        • API Reference
          • IdentityManager
          • BirdSdkApi
          • BirdTracker
            • Ecommerce
            • Conference
            • Messaging
            • Suppressions
            • Subscription
            • Survey
            • Web
            • Audiences
        • Web Push Notifications
          • Notification Interactions
  • Quickstarts
    • Conversations
    • Send an SMS message
    • Send an Email message
    • Send a WhatsApp message
Powered by GitBook
On this page
  • Setting Up Bird Verify API: A Step-by-Step Guide
  • Setting Up SMS Verification
  • Step 1: Country Coverage
  • Step 2: Install SMS Channels
  • Set Up WhatsApp 2FA
  • Step 3: Install WhatsApp Channel
  • Step 4 Create WhatsApp 2FA Template
  • Use a Two-Step Approach
  • Step 5. Prepare your API call

Was this helpful?

  1. Verify API

Verify API: Quick Start

Last updated 2 months ago

Was this helpful?

Setting Up Bird Verify API: A Step-by-Step Guide

The Bird Verify API empowers you to implement automated, multi-step verification strategies across various channels. This guide will walk you through the process of setting up Verify, focusing on SMS and WhatsApp integration.

Setting Up SMS Verification

Step 1: Country Coverage

  • Identify your target countries.

  • Submit a ticket to Bird to provision alphanumeric senders and/or numbers for those countries.

Step 2: Install SMS Channels

  • Navigate to Developers -> SMS -> SMS Setup.

  • Install SMS channels for each Bird-provisioned sender.

  • Crucially, always select "2FA" as the message type for navigator compatibility.

Bird strongly recommends using navigators over direct channel selection. Even if you start with just one SMS channel, when using the Verify API , always send OTPs s. Navigators abstract channel UUID changes, ensuring your integration remains stable even if you add or remove channels. This means your API calls will stay consistent, simplifying maintenance.

Set Up WhatsApp 2FA

Step 3: Install WhatsApp Channel

  • Navigate to Developers -> WhatsApp -> WhatsApp Setup -> Install WhatsApp.

  • You can use your own number or purchase a cost-effective number (e.g., a Canadian number).

Picture: use your own number

  • Important: the Phone number of your WhatsApp account is not directly visible to end-users during the verification. They will see your company logo and anime, making choosing a great number a secondary matter.

Tip: Don't delay setup trying to get a number from your own country, as these can be expensive or hard to obtain due to regulations. Using your own or a readily available number enables you to get started quickly. You can always add a localized number later as an improvement.

Step 4 Create WhatsApp 2FA Template

  • Go to Developers -> WhatsApp -> Manage Templates -> Create Template.

  • Tips, use 2FA template configurations

  • Set the authentication body's validity period to match your OTP validity (recommended: 300 seconds or less). This prevents stale OTPs from being delivered if a user's data connection is delayed.

  • If your business uses an app, enable 0-click authentication for automatic password autofill in the action button. You can do so in the Action Buttons -> Authentication Button. This feature works seamlessly on Android phones and gracefully skips on iPhones or unsupported Android versions.

Use a Two-Step Approach

When using the Verify API, always set up at least two steps (you can optionally add a third step via email). This provides the following advantages:

  • Benefit of WhatsApp-Only Features: You can showcase your brand logo and name to your users and utilize buttons and auto-complete, which are impossible on SMS.

  • Fallback Mechanism: Implement a two-step approach, starting with WhatsApp and automatically falling back to SMS when necessary.

  • Mitigating WhatsApp Limitations: Meta does not provide WhatsApp number lookup. Bird's Verify API automatically falls back to SMS when a "not supported" error occurs, ensuring high verification rates.

  • Seamless User Experience: This fallback is internal to the Bird platform and happens quickly, providing a smooth experience for your users.

For less time-sensitive application email could be used as a 3rd step

Step 5. Prepare your API call

The only action missing is Retrieving IDs:

  • WhatsApp channel and template IDs are available in WhatsApp Setup and WhatsApp -> Manage Templates, respectively.

  • OTP navigator UUID is visible in Developers -> Navigators -> Navigator Setup.

API Request Example:

{
    "identifier": {
        "phonenumber": "Recipient Number"
    },
    "maxAttempts": 3,
    "timeout": 300,
    "codeLength": 6,
    "steps": [
        {
            "channelId": "whatsapp_channel_ID",
            "template": {
                "projectId": "whatsapp_template_ID",
                "locale": "en",
                "version": "whatsapp_template_version"
            }
        },
        {
            "navigatorId": "navigator_UUID"
        }
    ]
}

Auto Fallback: Whenever a WhatsApp message fails, Verify will move to send an OTP via SMS without any action from your side. If or when needed, you can always retrigger a specific step (refer to for more info)

via navigator
API documentation