How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bird Verify Verifications API

Send a one-time passcode to a recipient and check the code they enter. Create a verification to send a passcode over email or SMS, then submit the recipient's code to verify it.

Bird Verify Verifications API is one of 65 APIs that Bird publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include verify-verifications. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 3 operations across 3 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 3 base URLs: https://{region}.platform.bird.com, https://platform.bird.com, http://localhost:8080.

3 operations 3 paths 17 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.bird.com
Authentication
HTTP Bearer, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Bird Verify Verifications API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the cookie as bird_session (CookieAuth). An API key is passed in the header as X-Realtime-Key (RealtimeKey). An API key is passed in the header as X-Realtime-Secret (RealtimeSecret). By default, every request must be authenticated.

  • BearerAuth — Pass the API key as a bearer token in the Authorization header. Keys use the format bk{region}. The prefix identifies the region and selects the API endpoint.…
  • CookieAuth — Session cookie set after signing in to the Bird dashboard. The cookie value is an opaque session token; no session data is stored in the cookie itself.
  • RealtimeKey — The Realtime app key. Together with X-Realtime-Secret, it authenticates a request to the Realtime API in addition to the workspace credential. Both values come…
  • RealtimeSecret — The Realtime app secret paired with X-Realtime-Key. The API returns the secret only when the key is created and does not store it. Create a new key and revoke…

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

verify-verifications 3

Send a one-time passcode to a recipient and check the code they enter. Create a verification to send a passcode over email or SMS, then submit the recipient's code to verify it.

POST
/v1/verify/verifications
Create a verification
createVerification 2 params body → 200400401402403422429500
POST
/v1/verify/verifications/check
Create a verification passcode check
createVerificationCheck 2 params body → 200400401403404422429500
POST
/v1/verify/verifications/next-channel
Create the next verification channel attempt
createVerificationNextChannel 2 params body → 200400401402403404422429

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are ErrorBody (11 properties), NextAction (5 properties), VerificationCheckResult (4 properties), VerificationOptions (3 properties). Each schema is shown below with its type and property counts.

ErrorDetail
object
2 properties 2 required
ErrorBody
object
11 properties 6 required
VerificationTo
object
The recipient to verify. Provide an email, a phonenumber, or both; at least one is required. The addresses also identify the verification: a check must supply…
2 properties
VerificationCheckResult
object
4 properties 2 required
Timestamps
object
2 properties 2 required
NextAction
object
5 properties 2 required
VerificationTerminalReason
string
Why a verification session reached its final state without succeeding: attemptsexhausted (too many incorrect passcodes), ttlelapsed (the time window elapsed be…
VerificationNextChannelRequest
object
1 property 1 required
VerificationChannelEntry
object
1 property 1 required
VerificationID
string
Error
object
1 property 1 required
VerificationChannel
string
The channel a passcode is delivered over. Open enum: new channels may be added over time, so treat any unrecognized value as a future channel rather than an er…
LanguageTag
string
A language tag in BCP-47 form, for example en or pt-BR.
VerificationCreateRequest
object
3 properties 1 required
VerificationCheckRequest
object
2 properties 2 required
Verification
VerificationOptions
object
Per-request overrides applied to this verification only.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-verify-verifications-api-openapi.yml Raw ↑

Other APIs Bird publishes across the network.

Bird Customer Data API
Bird Phone Numbers API
Bird Identity Verification API
Bird Touchpoints API
Bird Accounts API
Bird FAQ API
Bird Intent API
Bird SMS Messaging API
Bird Channels API
Bird Contacts API
Bird Conversations API
Bird Legacy MessageBird API
Where this information came from

This is an independent, third-party profile of Bird Verify Verifications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.