PhoneNumberInfo

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/whatsapp/json-schema/whatsapp-phone-number-info-schema.json",
  "title": "PhoneNumberInfo",
  "description": "Phone number information and status",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/whatsapp-business-messaging-api-openapi.yml#/components/schemas/PhoneNumberInfo",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID associated with the phone number"
    },
    "display_phone_number": {
      "type": "string",
      "description": "The string representation of the phone number"
    },
    "verified_name": {
      "type": "string",
      "description": "The verified name associated with the phone number"
    },
    "quality_rating": {
      "type": "string",
      "enum": [
        "GREEN",
        "YELLOW",
        "RED",
        "NA"
      ],
      "description": "The quality rating of the phone number based on how messages have been received by recipients in recent days.\n- GREEN: High Quality\n- YELLOW: Medium Quality\n- RED: Low Quality\n- NA: Quality has not been determined\n"
    },
    "code_verification_status": {
      "type": "string",
      "enum": [
        "VERIFIED",
        "UNVERIFIED"
      ],
      "description": "The two-step verification status for the phone number indicating whether the number has completed two-step verification.\n- VERIFIED: Phone number has completed two-step verification\n- UNVERIFIED: Two-step verification is pending or incomplete\n"
    },
    "name_status": {
      "type": "string",
      "enum": [
        "APPROVED",
        "AVAILABLE_WITHOUT_REVIEW",
        "DECLINED",
        "EXPIRED",
        "PENDING_REVIEW",
        "NONE"
      ],
      "description": "The status of a display name associated with a specific phone number.\n- APPROVED: The display name has been approved and is ready to use.\n- AVAILABLE_WITHOUT_REVIEW: The display name is ready to use without review.\n- DECLINED: The display name has not been approved.\n- EXPIRED: The display name approval has expired.\n- PENDING_REVIEW: The display name is under review.\n- NONE: No display name verification request exists.\n"
    }
  }
}