Skip to main content
Partner documentation moved to this site. The reference, request/response shapes, and the interactive Run panels are the canonical source going forward. The Postman collection is retired. New fields and a new status on the lookup responses. All additive, on the same read:client-accounts scope, so no re-consent is required.
  • New status: ActiveResolution. A taxpayer (or client account) that owes a balance but has every balance-carrying period covered by an active installment agreement now reads ActiveResolution instead of AtRisk.
  • Balances by year. Taxpayers and the client account now return balanceByYear, the balance split per tax year into principal, interest, penalties, credits, and net amount due.
  • Liens. Taxpayers now return liens (every lien, with status, filing date, secured balance, and secured periods) and a lienSummary rollup. The client account returns the lienSummary aggregated across its taxpayers.
  • Installment agreements. Taxpayers now return installmentAgreements (every agreement, with status, balances, and covered periods) and an installmentAgreementSummary rollup, including whether any balance is not covered by an active agreement. The client account returns the summary aggregated across its taxpayers.
  • Dark-mode badges. currentStatus now includes badgeGraphicUrlDark alongside badgeGraphicUrl, for embedding on dark backgrounds.
See Lookup results for field-level detail. The lookup endpoints also have clearer, more consistent auth-error handling. See Authentication Details for the full model.