Sign inGet Started

Create a verified number

POST
/v1/voice/verified-numbers
// This places a verification call to the number that reads out a code.
const verifiedNumber = await bird.voice.verifiedNumbers.create({ phone_number: "+14155551234", name: "Support line" });
console.log(verifiedNumber.id, verifiedNumber.status);
Response201
{
  "id": "vvn_01krdgeqcxet5s7t44vh8rt9mg",
  "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
  "phone_number": "+14155551234",
  "name": "Support line",
  "status": "pending",
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}
Registers a phone number as an outbound caller ID for the workspace and starts verification. The API places a verification call to the number that reads out a code; submit that code to the verify endpoint to prove ownership. The verified number is returned in the "pending" state until verification completes.
Idempotency is optional. For retry protection, supply an Idempotency-Key on the first attempt and reuse it with the same request. A retained successful response is replayed for three hours. Without a key, retries are processed normally and can return 409 if the number is already registered. If a response is lost, list the workspace's verified numbers to check the registration before trying again.
A 412 means required identity verification is incomplete or organization eligibility prevents registration. Follow the error's recovery guidance: complete missing verification, or contact support about an eligibility review or denial. An eligibility assessment still in progress returns 503; retry later.
Request Payload
phone_number
string
required
The phone number to register as an outbound caller ID, in E.164 format (a leading + followed by the country code and national number). Must be unique within the workspace. Creating the verified number starts verification: a verification call is placed to this number.
name
string
Your label for this verified number, to tell several registered numbers apart. Omit it to register the number without one and add it later. It is yours to choose and appears nowhere on a call, so it never affects what the person you are calling sees.
Response Payload
id
string
required
Unique identifier for this verified number.
workspace_id
string
required
phone_number
string
required
The phone number in E.164 format registered as an outbound caller ID.
name
nullable string
required
Your label for this verified number, to tell several registered numbers apart. null when the verified number has no label. It is yours to choose and appears nowhere on a call, so changing it never affects what the person you are calling sees. Set it with the verified number update operation.
status
string
required
Verification state of the verified number.
  • pending: the number is registered but ownership has not yet been proven.
  • verified: the workspace proved ownership of the number. Check the resource's activation or direction fields for outbound availability.
  • failed: terminal because the verification challenge expired or the attempt limit was exhausted. Delete the verified number and register it again to retry.
Open enum: additional states may be added over time, so treat an unrecognized value as a future state rather than an error.
Possible values (may grow over time): pending, verified, failed
outbound_enabled
boolean
required
Whether outbound caller ID activation has completed. A verified number can remain inactive until activation requirements are met. Outbound calls remain subject to routing and number ownership requirements.
verified_at
nullable string
required
When the verified number was verified. null when its status is pending or failed.
created_at
string
required
updated_at
string
required