voice-verified-numbers

Get a verified number

Returns the verified number with the given ID, including its verification status.

get/v1/voice/verified-numbers/{verified_number_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/voice/verified-numbers/{verified_number_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Verified number with its current verification status.

idstring required
workspace_idstring required
phone_numberstring required

The phone number in E.164 format registered as an outbound caller ID.

namestring nullable 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.

statusstring 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.

outbound_enabledboolean 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_atstring date-time nullable required

When the verified number was verified. null when its status is pending or failed.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "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"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.