ICON Developer Center
View as Markdown

ICON Developer Center

Build on ICON

Search education offers, submit leads and read standardized answers through one API. Everything you need to integrate, in one place.

QuickstartAPI reference

ICON is a lead-routing platform for education offers. Partners send ICON a lead; ICON finds the offers that lead qualifies for, checks duplicates, caps, eligibility and consent, and answers in real time.

These docs are public. Using the API needs an API key, issued by ICON to your affiliate account; see Authentication and API keys.

#Integration options

Search → results → submitAffiliate APISearch every offer on your campaign with one lead, poll for results as they arrive, then submit the lead to the result the consumer chose. Each result carries its logo, consent statement, programs, questions and your payout.Read more →POST a lead to one offerDirect lead postingAlready know the offer? Post the lead straight to it with your campaign and offer ids. Same endpoint, same standardized answer.Read more →Optional, server to serverDuplicate pre-checkAsk whether ICON would call a lead a duplicate before you post it. Send raw fields or SHA-256 hashes of the published normalized forms.Read more →status · reason · codeStandard responsesEvery answer carries the same three fields, from one catalog: a lower-case status, a sentence-case reason and a stable code with a retryable flag.Read more →

Also good to know

  • Other integration types: ask your ICON contact.
  • ICON does not send postbacks to affiliates today: the submit answer is the outcome.

#How a lead flows

  1. Search. POST /api/v1/engine/search with the lead, your campaign id and your affiliate id. ICON answers at once with its first results and a search id (icon_lead_id).
  2. Results. GET /api/v1/engine/results/{icon_lead_id} until processing_done is true. More results arrive while partner offers answer.
  3. Submit. POST /api/v1/engine/leads with the lead, the icon_result_id the consumer chose, the program and the answers to that result's questions.

Every answer carries status, reason and code. See Standard responses.

#Start here

  • Quickstart: a test lead from search to submit, with curl.
  • Endpoints: requests, responses and examples.
  • Field dictionary: the lead fields ICON reads and the values it stores.
  • Consent and TCPA: what to show and what to send.
  • Testing: test leads run the whole pipeline and are never delivered.

#For tools and AI assistants

Every page is also published as Markdown: add .md to its path (for example /quickstart.md). The index is llms.txt, all pages in one file are llms-full.txt, and the API description is openapi.json.

API base URL: https://iconroute.io

Generated 2026-09-28 from ICON's API definitions. Every page is also available as Markdown; the index is llms.txt.