CompanyDomainLookupItem

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/indexed-vc/main/json-schema/indexed-vc-company-domain-lookup-item-schema.json",
  "title": "CompanyDomainLookupItem",
  "x-generated": "2026-10-02",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/indexed-vc-openapi.yaml#/components/schemas/CompanyDomainLookupItem",
  "oneOf": [
    {
      "type": "object",
      "required": [
        "domain",
        "status",
        "credits_charged",
        "data"
      ],
      "properties": {
        "domain": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "const": "hit"
        },
        "credits_charged": {
          "type": "integer",
          "const": 1
        },
        "data": {
          "$ref": "#/$defs/CompanyCard"
        }
      }
    },
    {
      "type": "object",
      "required": [
        "domain",
        "status",
        "coverage_requested",
        "coverage_eta_days",
        "credits_charged"
      ],
      "properties": {
        "domain": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "const": "miss"
        },
        "coverage_requested": {
          "type": "boolean",
          "description": "true when the request was durably recorded for manual review; not a promise of admission or coverage. false means recording failed and the client can retry, or the domain belongs to a company outside coverage scope"
        },
        "coverage_status": {
          "type": "string",
          "enum": [
            "queued",
            "not_queued",
            "pending_enrichment",
            "scope_review",
            "not_in_coverage_scope"
          ],
          "description": "Why this domain missed: queued (recorded for review), not_queued (recording failed), pending_enrichment (held, profile not yet servable), scope_review (held, scope under review), not_in_coverage_scope (held, outside coverage scope; never served)"
        },
        "coverage_eta_days": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Currently null: manual review has no guaranteed completion date. Misses are never charged."
        },
        "credits_charged": {
          "type": "integer",
          "const": 0
        }
      }
    },
    {
      "type": "object",
      "required": [
        "domain",
        "status",
        "credits_charged"
      ],
      "properties": {
        "domain": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "const": "insufficient_credits"
        },
        "credits_charged": {
          "type": "integer",
          "const": 0
        }
      }
    }
  ],
  "$defs": {
    "CompanyCard": {
      "type": "object",
      "required": [
        "id",
        "name",
        "slug",
        "_revealed"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "slug": {
          "type": "string"
        },
        "logo_url": {
          "type": [
            "string",
            "null"
          ]
        },
        "website": {
          "type": [
            "string",
            "null"
          ]
        },
        "short_description": {
          "type": [
            "string",
            "null"
          ]
        },
        "industries": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "hq_city": {
          "type": [
            "string",
            "null"
          ]
        },
        "hq_country": {
          "type": [
            "string",
            "null"
          ]
        },
        "employee_count_range": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "1-10",
            "11-50",
            "51-200",
            "201-500",
            "501-1000",
            "1001-5000",
            "5001-10000",
            "10001+",
            null
          ]
        },
        "total_funding_raised": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Whole USD. Sum of disclosed itemized funding rounds at confidence 50+: equity rounds, notes, SAFEs, equity crowdfunding and grants. Grants are included; debt, IPOs, acquisitions and secondaries are not. Null when no counted round has a disclosed amount."
        },
        "operating_status": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "active",
            "acquired",
            "ipo",
            "closed",
            null
          ]
        },
        "_revealed": {
          "type": "boolean",
          "description": "true when this account has unlocked the entity's depth within 12 months"
        },
        "domain_match": {
          "$ref": "#/$defs/DomainMatch"
        }
      }
    },
    "DomainMatch": {
      "type": "object",
      "required": [
        "queried",
        "canonical_domain",
        "matched_via"
      ],
      "properties": {
        "queried": {
          "type": "string",
          "description": "Canonicalized domain supplied by the caller"
        },
        "canonical_domain": {
          "type": [
            "string",
            "null"
          ],
          "description": "Current website host on the matched company"
        },
        "matched_via": {
          "type": "string",
          "enum": [
            "canonical_domain",
            "alias_domain",
            "former_website"
          ]
        }
      }
    }
  }
}