API & Widget

Put CollegeLens on your website.

Embed CollegeLens tools on your website — a funding gap estimator, SAI calculator, or aid appeal letter builder — and connect students to the full CollegeLens experience.

Three embeddable tools: Plan Intake, SAI Estimator, Appeal Letter

Powered by CollegeLens with optional co-branding

Hosted iframe with API key and domain allowlisting

Available widgets

Plan Intake

Funding Gap Estimator

Students enter school, cost, and aid details to see their funding gap and get next steps.

data-mode="plan-intake"

SAI Estimator

Student Aid Index Calculator

Estimates federal aid eligibility using the SAI formula. Financial data stays in the browser.

data-mode="sai-estimator"

Appeal Letter

Aid Appeal Letter Builder

Guides students through building a financial aid appeal letter with a professional template.

data-mode="appeal-letter"

Quick start

  1. 1. Contact CollegeLens to receive an API key and approved domain allowlist.
  2. 2. Add the script tag and widget container to the page where you want the tool to appear.
  3. 3. Set data-mode to the widget you want to launch.
  4. 4. Publish. The loader script handles session creation, iframe mounting, resize, and event forwarding.

Install snippet

plan-intake
<script async src="https://collegelens.ai/embed/widget.js"></script>
<div
  data-collegelens-widget
  data-api-key="YOUR_API_KEY"
  data-mode="plan-intake"
  data-theme="default"
  style="max-width: 560px;"
></div>

SAI estimator snippet

sai-estimator
<script async src="https://collegelens.ai/embed/widget.js"></script>
<div
  data-collegelens-widget
  data-api-key="YOUR_API_KEY"
  data-mode="sai-estimator"
  data-theme="default"
  style="max-width: 560px;"
></div>

Appeal letter snippet

appeal-letter
<script async src="https://collegelens.ai/embed/widget.js"></script>
<div
  data-collegelens-widget
  data-api-key="YOUR_API_KEY"
  data-mode="appeal-letter"
  data-school-name="Ohio State University"
  data-theme="default"
  style="max-width: 560px;"
></div>

Manual mount API

Prefer the JavaScript API when you need to mount into a custom target or listen for widget events in your host page.

<script async src="https://collegelens.ai/embed/widget.js"></script>
<div id="collegelens-widget"></div>
<script>
  window.CollegeLensWidget.init({
    apiKey: "YOUR_API_KEY",
    target: "#collegelens-widget",
    mode: "sai-estimator",
    theme: "default",
    onEvent(detail) {
      console.log("CollegeLens widget event", detail.eventName, detail.payload);
    },
    initialData: {
      schoolName: "Ohio State University",
      state: "Ohio"
    }
  });
</script>
Creates widget sessions on demand with partner allowlisting built in
Keeps iframe height in sync automatically across step changes
Passes lifecycle and engagement events back to the host page
Supports handoff into the full CollegeLens planning experience

Shareable partner PDF

Download a partner-facing overview with product framing, UI preview panels, flow summaries, and implementation notes for internal review or distribution.

Download PDF