hubvibe-io.com

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "The 200 body of every paid /work call. `result` is the worker's own output (its schema is per route); everything else is the same on every /work route. A receipt for the job is at `receipt_url`.",
  "properties": {
    "attribution": {
      "$ref": "#/components/schemas/Attribution"
    },
    "billing_warning": {
      "description": "Present only when the charge was recorded with a caveat.",
      "examples": [
        "settlement pending"
      ],
      "type": "string"
    },
    "price_usd": {
      "description": "What this call cost, in USD.",
      "examples": [
        0.02
      ],
      "type": "number"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    },
    "receipt_id": {
      "description": "Receipt id for this job.",
      "examples": [
        "rcpt_9f1c2b3a4d5e6f70"
      ],
      "type": "string"
    },
    "receipt_url": {
      "description": "Where to fetch the machine-readable receipt (free, no payment).",
      "examples": [
        "/work/receipts/rcpt_9f1c2b3a4d5e6f70"
      ],
      "type": "string"
    },
    "result": {
      "properties": {
        "carrier": {
          "description": "Network the number range was issued to; null when not recorded (common for fixed lines).",
          "examples": [
            "T-Mobile"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "checked_at": {
          "description": "When this node read the source (UTC). Nothing here is cached.",
          "examples": [
            "2026-09-26T18:00:00Z"
          ],
          "format": "date-time",
          "type": "string"
        },
        "country": {
          "description": "Country name.",
          "examples": [
            "United Kingdom"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "country_code": {
          "description": "Calling code.",
          "examples": [
            44
          ],
          "type": "integer"
        },
        "e164": {
          "description": "E.164 form.",
          "examples": [
            "+442070313000"
          ],
          "type": "string"
        },
        "input": {
          "description": "The request.",
          "properties": {
            "number": {
              "description": "The number as given.",
              "examples": [
                "+44 20 7031 3000"
              ],
              "type": "string"
            },
            "region": {
              "description": "Region used for a national number.",
              "examples": [
                "GB"
              ],
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "number",
            "region"
          ],
          "type": "object"
        },
        "international": {
          "description": "International format.",
          "examples": [
            "+44 20 7031 3000"
          ],
          "type": "string"
        },
        "line_type": {
          "description": "Kind of line.",
          "enum": [
            "fixed_line",
            "mobile",
            "fixed_line_or_mobile",
            "toll_free",
            "premium_rate",
            "shared_cost",
            "voip",
            "personal_number",
            "pager",
            "uan",
            "voicemail",
            "unknown"
          ],
          "examples": [
            "fixed_line"
          ],
          "type": "string"
        },
        "location": {
          "description": "Area the number was issued to (city or region); null when unknown.",
          "examples": [
            "London"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "metadata_version": {
          "description": "libphonenumber metadata version used.",
          "examples": [
            "9.0.40"
          ],
          "type": "string"
        },
        "national": {
          "description": "National format.",
          "examples": [
            "020 7031 3000"
          ],
          "type": "string"
        },
        "notes": {
          "description": "Caveats.",
          "examples": [
            []
          ],
          "items": {
            "description": "A caveat.",
            "examples": [
              "Answered from the number alone."
            ],
            "type": "string"
          },
          "type": "array"
        },
        "possible": {
          "description": "The length is possible for the country.",
          "examples": [
            true
          ],
          "type": "boolean"
        },
        "region": {
          "description": "ISO country code the number belongs to.",
          "examples": [
            "GB"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "time_zones": {
          "description": "Time zones the number's area uses.",
          "examples": [
            [
              "Europe/London"
            ]
          ],
          "items": {
            "description": "An IANA time zone.",
            "examples": [
              "Europe/London"
            ],
            "type": "string"
          },
          "type": "array"
        },
        "valid": {
          "description": "A valid number in its country's numbering plan.",
          "examples": [
            true
          ],
          "type": "boolean"
        }
      },
      "required": [
        "input",
        "valid",
        "possible",
        "e164",
        "international",
        "national",
        "country_code",
        "region",
        "country",
        "location",
        "carrier",
        "line_type",
        "time_zones",
        "metadata_version",
        "notes",
        "checked_at"
      ],
      "type": "object"
    },
    "status": {
      "const": "ok",
      "description": "Present only on a delivered result.",
      "type": "string"
    },
    "worker": {
      "description": "Catalog name of the worker that ran.",
      "examples": [
        "market.quote"
      ],
      "type": "string"
    }
  },
  "required": [
    "status",
    "worker",
    "price_usd",
    "result",
    "provenance",
    "receipt_id",
    "receipt_url"
  ],
  "title": "phone.parse response",
  "type": "object"
}