Returns a client-account-wide compliance summary for the account containing the given
EIN: every taxpayer on the account, plus any not-yet-onboarded pending taxpayers. Each
taxpayer carries its own compliance status and detail. result
is null and currentStatus.status is NotMonitored when no accessible business matches.
Status values, badges, tin censoring, and isLookupMatch are explained in
Lookup results.
The client-account summary, or null when nothing matched.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"TaxRock API","description":"Access TaxRock data directly, or through a TaxRock user's authorization.","colors":{"primary":"#0072e1","light":"#35a4ff","dark":"#015cbe"},"logo":{"light":"https://mintcdn.com/taxrock/9N5jypJq8NMx5Km2/logo/taxrock-logo.png?fit=max\u0026auto=format\u0026n=9N5jypJq8NMx5Km2\u0026q=85\u0026s=dce72588c441829f2f1b172c3dd82edb","dark":"https://mintcdn.com/taxrock/9N5jypJq8NMx5Km2/logo/taxrock-logo-dark.png?fit=max\u0026auto=format\u0026n=9N5jypJq8NMx5Km2\u0026q=85\u0026s=16f5b070d1bc3bce774facc74104fae5"},"favicon":"https://mintcdn.com/taxrock/9N5jypJq8NMx5Km2/favicon.png?fit=max\u0026auto=format\u0026n=9N5jypJq8NMx5Km2\u0026q=85\u0026s=8b4e40fef5d4fa91eb545ca631fefb27","api":{"playground":{"proxy":true}},"navbar":{"primary":{"type":"button","label":"Contact us","href":"https://www.taxrock.com/contact"}},"footer":{"socials":{"website":"https://taxrock.com"}},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"taxrock","hasAudioNarration":false,"actualSubdomain":"taxrock","customDomains":["docs.taxrock.com"],"gitSource":{"type":"gitlab","owner":"taxrock","repo":"taxrock-backend","deployBranch":"master","contentDirectory":"partner-docs","isPrivate":true,"projectId":76213471,"mountPath":"","label":"","_id":"6adab581a234c3b50474782c"},"chroma":{"collectionId":"8deed7b8-3803-4d84-b9c0-ff29d9d5d829","liveDeploymentHistoryId":"6adaf83673fe31c4d05b84df","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adaf83673fe31c4d05b84df"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adaf83673fe31c4d05b84df","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API reference","count":22},{"language":"default","tag":"Delegate access","count":15},{"language":"default","tag":"Direct access","count":11},{"language":"default","tag":"Taxpayers","count":9},{"language":"default","tag":"Getting started","count":8},{"language":"default","tag":"Changelog","count":6},{"language":"default","tag":"Transcripts","count":6},{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"OAuth","count":3},{"language":"default","tag":"Client Accounts","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-dropdown-trigger .nav-dropdown-item-icon{align-self:stretch;height:auto;width:3.25rem}.nav-dropdown-trigger .nav-dropdown-item-icon svg{width:1.5rem;height:1.5rem}"}],"page":{"pagePath":"delegate-access/api-reference/client-accounts/lookup-by-ein","slug":"/delegate-access/api-reference/client-accounts/lookup-by-ein","pageMetadata":{"title":"Look up client account by EIN","openapi":"api-reference/openapi-delegate.json POST /client-accounts/lookup/ein","description":"POST /client-accounts/lookup/ein","href":"/delegate-access/api-reference/client-accounts/lookup-by-ein"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"POST /client-accounts/lookup/ein\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Returns a `,_jsx(_components.strong,{children:`client-account-wide`}),` compliance summary for the account containing the given\nEIN: every taxpayer on the account, plus any not-yet-onboarded pending taxpayers. Each\ntaxpayer carries its own compliance status and detail. `,_jsx(_components.code,{children:`result`}),`\nis `,_jsx(_components.code,{children:`null`}),` and `,_jsx(_components.code,{children:`currentStatus.status`}),` is `,_jsx(_components.code,{children:`NotMonitored`}),` when no accessible business matches.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Status values, badges, `,_jsx(_components.code,{children:`tin`}),` censoring, and `,_jsx(_components.code,{children:`isLookupMatch`}),` are explained in\n`,_jsx(_components.a,{href:`/api-reference/lookup-results`,children:`Lookup results`}),`.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Look up client account by EIN","openapi":"api-reference/openapi-delegate.json POST /client-accounts/lookup/ein","description":"POST /client-accounts/lookup/ein","href":"/delegate-access/api-reference/client-accounts/lookup-by-ein"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"lookupClientAccountByEin","summary":"Look up client account by EIN","tags":["Client Accounts"],"description":"POST /client-accounts/lookup/ein","requestBody":"9c3fd040-080e-4f66-bd10-306e0fbc60f9","responses":{"200":"438b1127-ba5e-4123-aa8c-46dd64404143","400":"775adc38-bdbd-4d21-b986-f19e0d16fa8b","401":"3ea8ef8d-dcab-421b-b329-cdfe0061f40d","403":"01095c97-b199-460d-924a-59eeeb5e5150"},"method":"post","type":"path","servers":["9dd7fac0-6506-4bf7-9fda-87868cd61a28"],"security":["a136c5eb-5775-45ff-b8a1-f44e20d5845f"],"path":"/client-accounts/lookup/ein","baseUrlOptions":["https://delegate-demo.api.taxrock.com"],"title":"Look up client account by EIN","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["businessEin"],"properties":{"businessEin":{"type":"string","description":"Business EIN: nine digits, with dashes and spaces ignored.","examples":["11-1111111"],"isRequired":true,"uniqueKey":"businessEin","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"businessEin":"11-1111111"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"438b1127-ba5e-4123-aa8c-46dd64404143":{"description":"Lookup completed. `result` carries the summary, or is null when nothing matched.","content":{"application/json":{"schema":{"type":"object","required":["currentStatus","result"],"properties":{"currentStatus":{"type":"object","required":["status","badgeGraphicUrl","badgeGraphicUrlDark"],"description":"Compliance status plus embeddable badge graphics. Always present on a response.","properties":{"status":{"type":"string","enum":["NotMonitored","DataPending","Compliant","ActiveResolution","AtRisk","NotCompliant"],"description":"See the Lookup results page for the full meaning of each value.","isRequired":true,"uniqueKey":"currentStatus.status","typeLabel":"enum\u003cstring>"},"badgeGraphicUrl":{"type":"string","format":"uri","description":"Publicly hosted SVG badge for this status, for light backgrounds.","isRequired":true,"uniqueKey":"currentStatus.badgeGraphicUrl","typeLabel":"string\u003curi>"},"badgeGraphicUrlDark":{"type":"string","format":"uri","description":"Publicly hosted SVG badge for this status, tuned for dark backgrounds.","isRequired":true,"uniqueKey":"currentStatus.badgeGraphicUrlDark","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"currentStatus","typeLabel":"object"},"result":{"oneOf":[{"type":"object","description":"The client-account summary, or null when nothing matched.","required":["clientAccountId","clientAccountName","amountDue","unallocatedCredits","numMissingReturns","balanceByYear","lienSummary","installmentAgreementSummary","taxpayers","pendingTaxpayers"],"properties":{"clientAccountId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"result.oneOf.0.clientAccountId","typeLabel":"string\u003cuuid>"},"clientAccountName":{"type":"string","isRequired":true,"uniqueKey":"result.oneOf.0.clientAccountName","typeLabel":"string"},"amountDue":{"type":"number","description":"Total balance owed across the client account.","isRequired":true,"uniqueKey":"result.oneOf.0.amountDue","typeLabel":"number"},"unallocatedCredits":{"type":"number","description":"Total credits not yet applied to a liability.","isRequired":true,"uniqueKey":"result.oneOf.0.unallocatedCredits","typeLabel":"number"},"numMissingReturns":{"type":"integer","description":"Number of required tax returns that are past due and not filed.","isRequired":true,"uniqueKey":"result.oneOf.0.numMissingReturns","typeLabel":"integer"},"balanceByYear":{"type":"array","items":{"type":"object","required":["year","principal","interest","penalties","allCredits","unallocatedCredits","amountDue"],"description":"Balance breakdown for a single tax year.","properties":{"year":{"type":"integer","isRequired":true,"uniqueKey":"result.oneOf.0.balanceByYear.items.[INDEX].year","typeLabel":"integer"},"principal":{"type":"number","isRequired":true,"uniqueKey":"result.oneOf.0.balanceByYear.items.[INDEX].principal","typeLabel":"number"},"interest":{"type":"number","isRequired":true,"uniqueKey":"result.oneOf.0.balanceByYear.items.[INDEX].interest","typeLabel":"number"},"penalties":{"type":"number","isRequired":true,"uniqueKey":"result.oneOf.0.balanceByYear.items.[INDEX].penalties","typeLabel":"number"},"allCredits":{"type":"number","description":"All credits applied for the year.","isRequired":true,"uniqueKey":"result.oneOf.0.balanceByYear.items.[INDEX].allCredits","typeLabel":"number"},"unallocatedCredits":{"type":"number","description":"Credits not yet applied to a liability.","isRequired":true,"uniqueKey":"result.oneOf.0.balanceByYear.items.[INDEX].unallocatedCredits","typeLabel":"number"},"amountDue":{"type":"number","description":"Net balance owed for the year.","isRequired":true,"uniqueKey":"result.oneOf.0.balanceByYear.items.[INDEX].amountDue","typeLabel":"number"}},"uniqueKey":"result.oneOf.0.balanceByYear.items.[INDEX]","typeLabel":"object"},"description":"Per-tax-year balance breakdown aggregated across the account's taxpayers, most recent year first.","isRequired":true,"uniqueKey":"result.oneOf.0.balanceByYear","typeLabel":"object[]"},"lienSummary":{"type":"object","required":["hasActiveLienSecuringNonZeroBalance","totalBalanceSecuredByLiens","mostRecentActiveLienFilingDate"],"description":"Lien rollups for a taxpayer or client account.","properties":{"hasActiveLienSecuringNonZeroBalance":{"type":"boolean","description":"True when at least one active lien secures a balance above zero.","isRequired":true,"uniqueKey":"result.oneOf.0.lienSummary.hasActiveLienSecuringNonZeroBalance","typeLabel":"boolean"},"totalBalanceSecuredByLiens":{"type":"number","description":"Total balance currently secured across active liens.","isRequired":true,"uniqueKey":"result.oneOf.0.lienSummary.totalBalanceSecuredByLiens","typeLabel":"number"},"mostRecentActiveLienFilingDate":{"oneOf":[{"type":"string","format":"date-time","description":"Filing date of the most recently filed active lien; null when there are none.","isRequired":true,"uniqueKey":"result.oneOf.0.lienSummary.mostRecentActiveLienFilingDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Filing date of the most recently filed active lien; null when there are none.","isRequired":true,"uniqueKey":"result.oneOf.0.lienSummary.mostRecentActiveLienFilingDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.oneOf.0.lienSummary.mostRecentActiveLienFilingDate","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"result.oneOf.0.lienSummary","typeLabel":"object"},"installmentAgreementSummary":{"type":"object","required":["hasBalanceNotCoveredByActiveIA","balanceNotCoveredByActiveIA","periodsNotCoveredByActiveIA"],"description":"Installment-agreement rollups for a taxpayer or client account.","properties":{"hasBalanceNotCoveredByActiveIA":{"type":"boolean","description":"True when a balance is owed that no active installment agreement covers.","isRequired":true,"uniqueKey":"result.oneOf.0.installmentAgreementSummary.hasBalanceNotCoveredByActiveIA","typeLabel":"boolean"},"balanceNotCoveredByActiveIA":{"type":"number","description":"Total balance not covered by an active installment agreement.","isRequired":true,"uniqueKey":"result.oneOf.0.installmentAgreementSummary.balanceNotCoveredByActiveIA","typeLabel":"number"},"periodsNotCoveredByActiveIA":{"type":"array","items":{"type":"object","required":["formName","taxYear","taxPeriod"],"description":"A single tax form and period.","properties":{"formName":{"type":"string","description":"IRS form name, e.g. \"1120\" or \"941\".","isRequired":true,"uniqueKey":"result.oneOf.0.installmentAgreementSummary.periodsNotCoveredByActiveIA.items.[INDEX].formName","typeLabel":"string"},"taxYear":{"type":"integer","isRequired":true,"uniqueKey":"result.oneOf.0.installmentAgreementSummary.periodsNotCoveredByActiveIA.items.[INDEX].taxYear","typeLabel":"integer"},"taxPeriod":{"type":"integer","description":"The tax period within the tax year.","isRequired":true,"uniqueKey":"result.oneOf.0.installmentAgreementSummary.periodsNotCoveredByActiveIA.items.[INDEX].taxPeriod","typeLabel":"integer"}},"uniqueKey":"result.oneOf.0.installmentAgreementSummary.periodsNotCoveredByActiveIA.items.[INDEX]","typeLabel":"object"},"description":"Periods with a balance not covered by an active installment agreement.","isRequired":true,"uniqueKey":"result.oneOf.0.installmentAgreementSummary.periodsNotCoveredByActiveIA","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"result.oneOf.0.installmentAgreementSummary","typeLabel":"object"},"taxpayers":{"type":"array","items":{"type":"object","required":["id","name","type","isLookupMatch","tin","isTinCensored","currentStatus","amountDue","unallocatedCredits","numMissingReturns","balanceByYear","lienSummary","installmentAgreementSummary","liens","installmentAgreements"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["Business","Individual"],"description":"Whether the taxpayer is a business (EIN) or an individual (SSN).","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"isLookupMatch":{"type":"boolean","description":"True on the row whose TIN matched the EIN you looked up.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].isLookupMatch","typeLabel":"boolean"},"tin":{"oneOf":[{"type":"string","description":"Unformatted digits. Raw nine-digit EIN for businesses, censored to the last four (xxxxx0123) for individuals.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].tin.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unformatted digits. Raw nine-digit EIN for businesses, censored to the last four (xxxxx0123) for individuals.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].tin.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].tin","typeLabel":"string | null"},"isTinCensored":{"type":"boolean","description":"True when `tin` is censored.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].isTinCensored","typeLabel":"boolean"},"currentStatus":{"type":"object","required":["status","badgeGraphicUrl","badgeGraphicUrlDark"],"description":"Compliance status plus embeddable badge graphics. Always present on a response.","properties":{"status":{"type":"string","enum":["NotMonitored","DataPending","Compliant","ActiveResolution","AtRisk","NotCompliant"],"description":"See the Lookup results page for the full meaning of each value.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].currentStatus.status","typeLabel":"enum\u003cstring>"},"badgeGraphicUrl":{"type":"string","format":"uri","description":"Publicly hosted SVG badge for this status, for light backgrounds.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].currentStatus.badgeGraphicUrl","typeLabel":"string\u003curi>"},"badgeGraphicUrlDark":{"type":"string","format":"uri","description":"Publicly hosted SVG badge for this status, tuned for dark backgrounds.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].currentStatus.badgeGraphicUrlDark","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].currentStatus","typeLabel":"object"},"amountDue":{"oneOf":[{"type":"number","description":"Null while this taxpayer's data is pending.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].amountDue.oneOf.0","typeLabel":"number"},{"type":"null","description":"Null while this taxpayer's data is pending.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].amountDue.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].amountDue","typeLabel":"number | null"},"unallocatedCredits":{"oneOf":[{"type":"number","description":"Null while this taxpayer's data is pending.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].unallocatedCredits.oneOf.0","typeLabel":"number"},{"type":"null","description":"Null while this taxpayer's data is pending.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].unallocatedCredits.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].unallocatedCredits","typeLabel":"number | null"},"numMissingReturns":{"oneOf":[{"type":"integer","description":"Number of required tax returns that are past due and not filed. Null while data is pending.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].numMissingReturns.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of required tax returns that are past due and not filed. Null while data is pending.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].numMissingReturns.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].numMissingReturns","typeLabel":"integer | null"},"balanceByYear":{"type":"array","items":{"type":"object","required":["year","principal","interest","penalties","allCredits","unallocatedCredits","amountDue"],"description":"Balance breakdown for a single tax year.","properties":{"year":{"type":"integer","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].balanceByYear.items.[INDEX].year","typeLabel":"integer"},"principal":{"type":"number","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].balanceByYear.items.[INDEX].principal","typeLabel":"number"},"interest":{"type":"number","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].balanceByYear.items.[INDEX].interest","typeLabel":"number"},"penalties":{"type":"number","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].balanceByYear.items.[INDEX].penalties","typeLabel":"number"},"allCredits":{"type":"number","description":"All credits applied for the year.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].balanceByYear.items.[INDEX].allCredits","typeLabel":"number"},"unallocatedCredits":{"type":"number","description":"Credits not yet applied to a liability.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].balanceByYear.items.[INDEX].unallocatedCredits","typeLabel":"number"},"amountDue":{"type":"number","description":"Net balance owed for the year.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].balanceByYear.items.[INDEX].amountDue","typeLabel":"number"}},"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].balanceByYear.items.[INDEX]","typeLabel":"object"},"description":"Per-tax-year balance breakdown for this taxpayer, most recent year first.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].balanceByYear","typeLabel":"object[]"},"lienSummary":{"type":"object","required":["hasActiveLienSecuringNonZeroBalance","totalBalanceSecuredByLiens","mostRecentActiveLienFilingDate"],"description":"Lien rollups for a taxpayer or client account.","properties":{"hasActiveLienSecuringNonZeroBalance":{"type":"boolean","description":"True when at least one active lien secures a balance above zero.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].lienSummary.hasActiveLienSecuringNonZeroBalance","typeLabel":"boolean"},"totalBalanceSecuredByLiens":{"type":"number","description":"Total balance currently secured across active liens.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].lienSummary.totalBalanceSecuredByLiens","typeLabel":"number"},"mostRecentActiveLienFilingDate":{"oneOf":[{"type":"string","format":"date-time","description":"Filing date of the most recently filed active lien; null when there are none.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].lienSummary.mostRecentActiveLienFilingDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Filing date of the most recently filed active lien; null when there are none.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].lienSummary.mostRecentActiveLienFilingDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].lienSummary.mostRecentActiveLienFilingDate","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].lienSummary","typeLabel":"object"},"installmentAgreementSummary":{"type":"object","required":["hasBalanceNotCoveredByActiveIA","balanceNotCoveredByActiveIA","periodsNotCoveredByActiveIA"],"description":"Installment-agreement rollups for a taxpayer or client account.","properties":{"hasBalanceNotCoveredByActiveIA":{"type":"boolean","description":"True when a balance is owed that no active installment agreement covers.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreementSummary.hasBalanceNotCoveredByActiveIA","typeLabel":"boolean"},"balanceNotCoveredByActiveIA":{"type":"number","description":"Total balance not covered by an active installment agreement.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreementSummary.balanceNotCoveredByActiveIA","typeLabel":"number"},"periodsNotCoveredByActiveIA":{"type":"array","items":{"type":"object","required":["formName","taxYear","taxPeriod"],"description":"A single tax form and period.","properties":{"formName":{"type":"string","description":"IRS form name, e.g. \"1120\" or \"941\".","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreementSummary.periodsNotCoveredByActiveIA.items.[INDEX].formName","typeLabel":"string"},"taxYear":{"type":"integer","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreementSummary.periodsNotCoveredByActiveIA.items.[INDEX].taxYear","typeLabel":"integer"},"taxPeriod":{"type":"integer","description":"The tax period within the tax year.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreementSummary.periodsNotCoveredByActiveIA.items.[INDEX].taxPeriod","typeLabel":"integer"}},"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreementSummary.periodsNotCoveredByActiveIA.items.[INDEX]","typeLabel":"object"},"description":"Periods with a balance not covered by an active installment agreement.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreementSummary.periodsNotCoveredByActiveIA","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreementSummary","typeLabel":"object"},"liens":{"type":"array","items":{"type":"object","required":["id","status","filingDate","currentSecuredBalance","securedPeriods","fullyRemovedDate","balanceAtRemoval"],"description":"A federal tax lien on the taxpayer.","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["Active","Released","Removed"],"description":"Lien lifecycle state.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"filingDate":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].filingDate","typeLabel":"string\u003cdate-time>"},"currentSecuredBalance":{"type":"number","description":"Balance currently secured by this lien.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].currentSecuredBalance","typeLabel":"number"},"securedPeriods":{"type":"array","items":{"type":"object","required":["formName","taxYear","taxPeriod"],"description":"A single tax form and period.","properties":{"formName":{"type":"string","description":"IRS form name, e.g. \"1120\" or \"941\".","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].securedPeriods.items.[INDEX].formName","typeLabel":"string"},"taxYear":{"type":"integer","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].securedPeriods.items.[INDEX].taxYear","typeLabel":"integer"},"taxPeriod":{"type":"integer","description":"The tax period within the tax year.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].securedPeriods.items.[INDEX].taxPeriod","typeLabel":"integer"}},"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].securedPeriods.items.[INDEX]","typeLabel":"object"},"description":"Periods still securing a balance under this lien.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].securedPeriods","typeLabel":"object[]"},"fullyRemovedDate":{"oneOf":[{"type":"string","format":"date-time","description":"When the lien was fully removed; null while active.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].fullyRemovedDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the lien was fully removed; null while active.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].fullyRemovedDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].fullyRemovedDate","typeLabel":"string\u003cdate-time> | null"},"balanceAtRemoval":{"oneOf":[{"type":"number","description":"Secured balance at the time of removal; null while active.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].balanceAtRemoval.oneOf.0","typeLabel":"number"},{"type":"null","description":"Secured balance at the time of removal; null while active.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].balanceAtRemoval.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX].balanceAtRemoval","typeLabel":"number | null"}},"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens.items.[INDEX]","typeLabel":"object"},"description":"All liens on the taxpayer, any status.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].liens","typeLabel":"object[]"},"installmentAgreements":{"type":"array","items":{"type":"object","required":["id","status","startDate","endDate","currentBalance","balanceAtClose","totalPaid","coveredPeriods"],"description":"An installment agreement on the taxpayer.","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["Requested","Pending","Active","PaidOff","Defaulted","Removed"],"description":"Installment-agreement lifecycle state.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"startDate":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].startDate","typeLabel":"string\u003cdate-time>"},"endDate":{"oneOf":[{"type":"string","format":"date-time","description":"When the agreement ended; null while open.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].endDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the agreement ended; null while open.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].endDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].endDate","typeLabel":"string\u003cdate-time> | null"},"currentBalance":{"type":"number","description":"Balance remaining under the agreement.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].currentBalance","typeLabel":"number"},"balanceAtClose":{"oneOf":[{"type":"number","description":"Balance when the agreement closed; null while open.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].balanceAtClose.oneOf.0","typeLabel":"number"},{"type":"null","description":"Balance when the agreement closed; null while open.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].balanceAtClose.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].balanceAtClose","typeLabel":"number | null"},"totalPaid":{"type":"number","description":"Total paid toward the agreement to date.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].totalPaid","typeLabel":"number"},"coveredPeriods":{"type":"array","items":{"type":"object","required":["formName","taxYear","taxPeriod"],"description":"A single tax form and period.","properties":{"formName":{"type":"string","description":"IRS form name, e.g. \"1120\" or \"941\".","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].coveredPeriods.items.[INDEX].formName","typeLabel":"string"},"taxYear":{"type":"integer","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].coveredPeriods.items.[INDEX].taxYear","typeLabel":"integer"},"taxPeriod":{"type":"integer","description":"The tax period within the tax year.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].coveredPeriods.items.[INDEX].taxPeriod","typeLabel":"integer"}},"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].coveredPeriods.items.[INDEX]","typeLabel":"object"},"description":"Periods currently covered by this agreement.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX].coveredPeriods","typeLabel":"object[]"}},"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements.items.[INDEX]","typeLabel":"object"},"description":"All installment agreements on the taxpayer, any status.","isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX].installmentAgreements","typeLabel":"object[]"}},"uniqueKey":"result.oneOf.0.taxpayers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"result.oneOf.0.taxpayers","typeLabel":"object[]"},"pendingTaxpayers":{"type":"array","items":{"type":"object","required":["id","name","type","isLookupMatch","tin","isTinCensored"],"description":"A taxpayer added to the client account but not yet onboarded.","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"result.oneOf.0.pendingTaxpayers.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"result.oneOf.0.pendingTaxpayers.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["Business","Individual"],"description":"Whether the taxpayer is a business (EIN) or an individual (SSN).","isRequired":true,"uniqueKey":"result.oneOf.0.pendingTaxpayers.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"isLookupMatch":{"type":"boolean","isRequired":true,"uniqueKey":"result.oneOf.0.pendingTaxpayers.items.[INDEX].isLookupMatch","typeLabel":"boolean"},"tin":{"oneOf":[{"type":"string","description":"Null if not provided yet.","isRequired":true,"uniqueKey":"result.oneOf.0.pendingTaxpayers.items.[INDEX].tin.oneOf.0","typeLabel":"string"},{"type":"null","description":"Null if not provided yet.","isRequired":true,"uniqueKey":"result.oneOf.0.pendingTaxpayers.items.[INDEX].tin.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.oneOf.0.pendingTaxpayers.items.[INDEX].tin","typeLabel":"string | null"},"isTinCensored":{"type":"boolean","isRequired":true,"uniqueKey":"result.oneOf.0.pendingTaxpayers.items.[INDEX].isTinCensored","typeLabel":"boolean"}},"uniqueKey":"result.oneOf.0.pendingTaxpayers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"result.oneOf.0.pendingTaxpayers","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"The client-account summary, or null when nothing matched.","isRequired":true,"uniqueKey":"result.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"available":{"title":"available","value":{"currentStatus":{"status":"NotCompliant","badgeGraphicUrl":"https://taxrock-assets.s3.us-east-2.amazonaws.com/public/status-badges/taxrock-badge-not-compliant.svg","badgeGraphicUrlDark":"https://taxrock-assets.s3.us-east-2.amazonaws.com/public/status-badges/taxrock-badge-not-compliant-dark.svg"},"result":{"clientAccountId":"8f3c1e2a-2b44-4c1f-9a0e-1d2c3b4a5e6f","clientAccountName":"Acme Holdings","amountDue":18452.3,"unallocatedCredits":0,"numMissingReturns":1,"balanceByYear":[{"year":2023,"principal":14000,"interest":2900,"penalties":1552.3,"allCredits":0,"unallocatedCredits":0,"amountDue":18452.3}],"lienSummary":{"hasActiveLienSecuringNonZeroBalance":true,"totalBalanceSecuredByLiens":18000,"mostRecentActiveLienFilingDate":"2024-05-14T00:00:00Z"},"installmentAgreementSummary":{"hasBalanceNotCoveredByActiveIA":true,"balanceNotCoveredByActiveIA":18000,"periodsNotCoveredByActiveIA":[{"formName":"1120","taxYear":2023,"taxPeriod":0}]},"taxpayers":[{"id":"1a2b3c4d-0000-0000-0000-000000000001","name":"Acme Holdings LLC","type":"Business","isLookupMatch":true,"tin":"111111111","isTinCensored":false,"currentStatus":{"status":"NotCompliant","badgeGraphicUrl":"https://taxrock-assets.s3.us-east-2.amazonaws.com/public/status-badges/taxrock-badge-not-compliant.svg","badgeGraphicUrlDark":"https://taxrock-assets.s3.us-east-2.amazonaws.com/public/status-badges/taxrock-badge-not-compliant-dark.svg"},"amountDue":18000,"unallocatedCredits":0,"numMissingReturns":1,"balanceByYear":[{"year":2023,"principal":14000,"interest":2600,"penalties":1400,"allCredits":0,"unallocatedCredits":0,"amountDue":18000}],"lienSummary":{"hasActiveLienSecuringNonZeroBalance":true,"totalBalanceSecuredByLiens":18000,"mostRecentActiveLienFilingDate":"2024-05-14T00:00:00Z"},"installmentAgreementSummary":{"hasBalanceNotCoveredByActiveIA":true,"balanceNotCoveredByActiveIA":18000,"periodsNotCoveredByActiveIA":[{"formName":"1120","taxYear":2023,"taxPeriod":0}]},"liens":[{"id":"3c4d5e6f-0000-0000-0000-000000000001","status":"Active","filingDate":"2024-05-14T00:00:00Z","currentSecuredBalance":18000,"securedPeriods":[{"formName":"1120","taxYear":2023,"taxPeriod":0}],"fullyRemovedDate":null,"balanceAtRemoval":null}],"installmentAgreements":[]},{"id":"1a2b3c4d-0000-0000-0000-000000000002","name":"Jane Q Doe","type":"Individual","isLookupMatch":false,"tin":"xxxxx0000","isTinCensored":true,"currentStatus":{"status":"AtRisk","badgeGraphicUrl":"https://taxrock-assets.s3.us-east-2.amazonaws.com/public/status-badges/taxrock-badge-at-risk.svg","badgeGraphicUrlDark":"https://taxrock-assets.s3.us-east-2.amazonaws.com/public/status-badges/taxrock-badge-at-risk-dark.svg"},"amountDue":452.3,"unallocatedCredits":0,"numMissingReturns":0,"balanceByYear":[{"year":2023,"principal":400,"interest":40,"penalties":12.3,"allCredits":0,"unallocatedCredits":0,"amountDue":452.3}],"lienSummary":{"hasActiveLienSecuringNonZeroBalance":false,"totalBalanceSecuredByLiens":0,"mostRecentActiveLienFilingDate":null},"installmentAgreementSummary":{"hasBalanceNotCoveredByActiveIA":false,"balanceNotCoveredByActiveIA":0,"periodsNotCoveredByActiveIA":[]},"liens":[],"installmentAgreements":[{"id":"4d5e6f70-0000-0000-0000-000000000001","status":"Active","startDate":"2024-02-01T00:00:00Z","endDate":null,"currentBalance":452.3,"balanceAtClose":null,"totalPaid":300,"coveredPeriods":[{"formName":"1040","taxYear":2023,"taxPeriod":0}]}]}],"pendingTaxpayers":[]}}},"dataPending":{"title":"dataPending","value":{"currentStatus":{"status":"DataPending","badgeGraphicUrl":"https://taxrock-assets.s3.us-east-2.amazonaws.com/public/status-badges/taxrock-badge-data-pending.svg","badgeGraphicUrlDark":"https://taxrock-assets.s3.us-east-2.amazonaws.com/public/status-badges/taxrock-badge-data-pending-dark.svg"},"result":{"clientAccountId":"7e6d5c4b-3a29-4817-8c6d-5e4f3a2b1c09","clientAccountName":"Newco Ventures","amountDue":0,"unallocatedCredits":0,"numMissingReturns":0,"balanceByYear":[],"lienSummary":{"hasActiveLienSecuringNonZeroBalance":false,"totalBalanceSecuredByLiens":0,"mostRecentActiveLienFilingDate":null},"installmentAgreementSummary":{"hasBalanceNotCoveredByActiveIA":false,"balanceNotCoveredByActiveIA":0,"periodsNotCoveredByActiveIA":[]},"taxpayers":[{"id":"2b3c4d5e-0000-0000-0000-000000000001","name":"Newco Ventures Inc","type":"Business","isLookupMatch":true,"tin":"000000000","isTinCensored":false,"currentStatus":{"status":"DataPending","badgeGraphicUrl":"https://taxrock-assets.s3.us-east-2.amazonaws.com/public/status-badges/taxrock-badge-data-pending.svg","badgeGraphicUrlDark":"https://taxrock-assets.s3.us-east-2.amazonaws.com/public/status-badges/taxrock-badge-data-pending-dark.svg"},"amountDue":null,"unallocatedCredits":null,"numMissingReturns":null,"balanceByYear":[],"lienSummary":{"hasActiveLienSecuringNonZeroBalance":false,"totalBalanceSecuredByLiens":0,"mostRecentActiveLienFilingDate":null},"installmentAgreementSummary":{"hasBalanceNotCoveredByActiveIA":false,"balanceNotCoveredByActiveIA":0,"periodsNotCoveredByActiveIA":[]},"liens":[],"installmentAgreements":[]}],"pendingTaxpayers":[{"id":"2b3c4d5e-0000-0000-0000-000000000002","name":"Side Co LLC","type":"Business","isLookupMatch":false,"tin":"000000000","isTinCensored":false}]}}},"notMonitored":{"title":"notMonitored","value":{"currentStatus":{"status":"NotMonitored","badgeGraphicUrl":"https://taxrock-assets.s3.us-east-2.amazonaws.com/public/status-badges/taxrock-badge-not-monitored.svg","badgeGraphicUrlDark":"https://taxrock-assets.s3.us-east-2.amazonaws.com/public/status-badges/taxrock-badge-not-monitored-dark.svg"},"result":null}}},"exampleType":"examples"}},"exampleType":"examples"},"775adc38-bdbd-4d21-b986-f19e0d16fa8b":{"description":"The `businessEin` was missing or malformed, or the request body could not be read.","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Machine-readable error code, e.g. `invalid_request` or `forbidden`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"invalidEin":{"title":"invalidEin","value":{"error":"invalid_ein","message":"businessEin must contain nine digits; dashes and spaces are ignored."}},"invalidRequest":{"title":"invalidRequest","value":{"error":"invalid_request","message":"A non-empty businessEin string is required."}},"malformedBody":{"title":"malformedBody","value":{"error":"invalid_request","message":"Request body is invalid or malformed JSON."}}},"exampleType":"examples"}},"exampleType":"examples"},"3ea8ef8d-dcab-421b-b329-cdfe0061f40d":{"description":"Missing or invalid access token. Refresh the token, or send the user back through the authorization flow.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"01095c97-b199-460d-924a-59eeeb5e5150":{"description":"`error` is `insufficient_scope` when the token lacks the `read:client-accounts` scope, or `forbidden` when the connected user is not eligible or lacks permission.","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Machine-readable error code, e.g. `invalid_request` or `forbidden`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"insufficientScope":{"title":"insufficientScope","value":{"error":"insufficient_scope","message":"Access token is missing the required scope. Re-run authorize requesting: read:client-accounts."}},"forbidden":{"title":"forbidden","value":{"error":"forbidden","message":"Caller lacks the required permission."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"a136c5eb-5775-45ff-b8a1-f44e20d5845f":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The access token obtained from the OAuth flow, sent as a Bearer credential.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"9dd7fac0-6506-4bf7-9fda-87868cd61a28":{"url":"https://delegate-demo.api.taxrock.com","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The access token obtained from the OAuth flow, sent as a Bearer credential.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The access token obtained from the OAuth flow, sent as a Bearer credential.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi-delegate.json"},"subdomain":"taxrock","siteName":"TaxRock API","title":"Look up client account by EIN - TaxRock API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T01:17:00.564Z","originalFileLocation":"delegate-access/api-reference/client-accounts/lookup-by-ein.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"POST /client-accounts/lookup/ein\">\u003cmeta data-mint-head name=\"application-name\" content=\"TaxRock API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/taxrock/oFTNNbIG-Kf_S3ku/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/taxrock/oFTNNbIG-Kf_S3ku/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/taxrock/oFTNNbIG-Kf_S3ku/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/taxrock/oFTNNbIG-Kf_S3ku/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/taxrock/oFTNNbIG-Kf_S3ku/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/taxrock/oFTNNbIG-Kf_S3ku/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/taxrock/oFTNNbIG-Kf_S3ku/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/taxrock/oFTNNbIG-Kf_S3ku/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/taxrock/oFTNNbIG-Kf_S3ku/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Look up client account by EIN - TaxRock API\">\u003cmeta data-mint-head property=\"og:description\" content=\"POST /client-accounts/lookup/ein\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"TaxRock API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.taxrock.com/delegate-access/api-reference/client-accounts/lookup-by-ein\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://taxrock.mintlify.app/_mintlify/api/og/v2?division=Client+Accounts\u0026amp;title=Look+up+client+account+by+EIN\u0026amp;description=POST+%2Fclient-accounts%2Flookup%2Fein\u0026amp;theme=f6fe9faa28612e0c2f492efb\u0026amp;signature=5411f533dadd03ded8592abe2ff76f2d211563f5e3e7d19d804bbabf1b43bcad\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Look up client account by EIN - TaxRock API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"POST /client-accounts/lookup/ein\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://taxrock.mintlify.app/_mintlify/api/og/v2?division=Client+Accounts\u0026amp;title=Look+up+client+account+by+EIN\u0026amp;description=POST+%2Fclient-accounts%2Flookup%2Fein\u0026amp;theme=f6fe9faa28612e0c2f492efb\u0026amp;signature=5411f533dadd03ded8592abe2ff76f2d211563f5e3e7d19d804bbabf1b43bcad\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/taxrock/oFTNNbIG-Kf_S3ku/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"TaxRock API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0072e1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.taxrock.com/delegate-access/api-reference/client-accounts/lookup-by-ein\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/delegate-access/api-reference/client-accounts/lookup-by-ein.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.taxrock.com/#organization\",\"name\":\"TaxRock API\",\"url\":\"https://docs.taxrock.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/taxrock/9N5jypJq8NMx5Km2/logo/taxrock-logo.png?fit=max\u0026auto=format\u0026n=9N5jypJq8NMx5Km2\u0026q=85\u0026s=dce72588c441829f2f1b172c3dd82edb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.taxrock.com#website\",\"name\":\"TaxRock API\",\"url\":\"https://docs.taxrock.com\",\"publisher\":{\"@id\":\"https://docs.taxrock.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.taxrock.com/delegate-access/api-reference/client-accounts/lookup-by-ein#webpage\",\"url\":\"https://docs.taxrock.com/delegate-access/api-reference/client-accounts/lookup-by-ein\",\"name\":\"Look up client account by EIN\",\"description\":\"POST /client-accounts/lookup/ein\",\"dateModified\":\"2026-10-23T01:17:00.564Z\",\"isPartOf\":{\"@id\":\"https://docs.taxrock.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.taxrock.com/delegate-access/api-reference/client-accounts/lookup-by-ein#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.taxrock.com/delegate-access/api-reference/client-accounts/lookup-by-ein#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Client Accounts\",\"item\":\"https://docs.taxrock.com/delegate-access/api-reference/client-accounts/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Look up client account by EIN\",\"item\":\"https://docs.taxrock.com/delegate-access/api-reference/client-accounts/lookup-by-ein\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.taxrock.com/delegate-access/api-reference/client-accounts/lookup-by-ein#apireference\",\"headline\":\"Look up client account by EIN\",\"name\":\"Look up client account by EIN\",\"description\":\"POST /client-accounts/lookup/ein\",\"url\":\"https://docs.taxrock.com/delegate-access/api-reference/client-accounts/lookup-by-ein\",\"mainEntityOfPage\":{\"@id\":\"https://docs.taxrock.com/delegate-access/api-reference/client-accounts/lookup-by-ein#webpage\"},\"dateModified\":\"2026-10-23T01:17:00.564Z\",\"publisher\":{\"@id\":\"https://docs.taxrock.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.taxrock.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"TaxRock API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"TaxRock API","nav":{"global":null,"tabs":[{"tab":"Getting started","pages":[{"title":"Getting started","href":"/overview"}]},{"tab":"API reference","dropdowns":[{"dropdown":"Direct access","icon":"key","description":"Client credentials for one organization","groups":[{"group":"OAuth","pages":[{"title":"Get a token","openapi":"api-reference/oauth-token-direct.json POST /oauth/token","href":"/direct-access/api-reference/authentication/token"}]},{"group":"Client Accounts","pages":[{"title":"List client accounts","openapi":"api-reference/openapi-direct.json GET /client-accounts","href":"/direct-access/api-reference/client-accounts/list"}]},{"group":"Taxpayers","pages":[{"title":"List taxpayers","openapi":"api-reference/openapi-direct.json GET /taxpayers","href":"/direct-access/api-reference/taxpayers/list"},{"title":"List a taxpayer's Wage \u0026 Income transcripts","openapi":"api-reference/openapi-direct.json GET /taxpayers/{id}/transcripts/wage-and-income","href":"/direct-access/api-reference/taxpayers/wage-and-income"},{"title":"List a taxpayer's return transcripts","openapi":"api-reference/openapi-direct.json GET /taxpayers/{id}/transcripts/return","href":"/direct-access/api-reference/taxpayers/return"},{"title":"List a taxpayer's account transcripts","openapi":"api-reference/openapi-direct.json GET /taxpayers/{id}/transcripts/account","href":"/direct-access/api-reference/taxpayers/account"}]},{"group":"Transcripts","pages":[{"title":"Get a Wage \u0026 Income transcript","openapi":"api-reference/openapi-direct.json GET /transcripts/wage-and-income/{id}","href":"/direct-access/api-reference/transcripts/wage-and-income"},{"title":"Get a return transcript","openapi":"api-reference/openapi-direct.json GET /transcripts/return/{id}","href":"/direct-access/api-reference/transcripts/return"},{"title":"Get an account transcript","openapi":"api-reference/openapi-direct.json GET /transcripts/account/{id}","href":"/direct-access/api-reference/transcripts/account"}]}]},{"dropdown":"Delegate access","icon":"user-check","description":"A TaxRock user connects your app","groups":[{"group":"OAuth","pages":[{"title":"Authorize","href":"/delegate-access/api-reference/authentication/authorize"},{"title":"Get or refresh a token","openapi":"api-reference/oauth-token-delegate.json POST /oauth/token","href":"/delegate-access/api-reference/authentication/token"}]},{"group":"Client Accounts","pages":[{"title":"List client accounts","openapi":"api-reference/openapi-delegate.json GET /client-accounts","description":"GET /client-accounts","href":"/delegate-access/api-reference/client-accounts/list"},{"title":"Look up client account by EIN","openapi":"api-reference/openapi-delegate.json POST /client-accounts/lookup/ein","href":"/delegate-access/api-reference/client-accounts/lookup-by-ein"}]},{"group":"Taxpayers","pages":[{"title":"List taxpayers","openapi":"api-reference/openapi-delegate.json GET /taxpayers","description":"GET /taxpayers","href":"/delegate-access/api-reference/taxpayers/list"},{"title":"Look up taxpayer by EIN","openapi":"api-reference/openapi-delegate.json POST /taxpayers/lookup/ein","href":"/delegate-access/api-reference/taxpayers/lookup-by-ein"},{"title":"List a taxpayer's Wage \u0026 Income transcripts","openapi":"api-reference/openapi-delegate.json GET /taxpayers/{id}/transcripts/wage-and-income","href":"/delegate-access/api-reference/taxpayers/wage-and-income"},{"title":"List a taxpayer's return transcripts","openapi":"api-reference/openapi-delegate.json GET /taxpayers/{id}/transcripts/return","href":"/delegate-access/api-reference/taxpayers/return"},{"title":"List a taxpayer's account transcripts","openapi":"api-reference/openapi-delegate.json GET /taxpayers/{id}/transcripts/account","href":"/delegate-access/api-reference/taxpayers/account"}]},{"group":"Transcripts","pages":[{"title":"Get a Wage \u0026 Income transcript","openapi":"api-reference/openapi-delegate.json GET /transcripts/wage-and-income/{id}","href":"/delegate-access/api-reference/transcripts/wage-and-income"},{"title":"Get a return transcript","openapi":"api-reference/openapi-delegate.json GET /transcripts/return/{id}","href":"/delegate-access/api-reference/transcripts/return"},{"title":"Get an account transcript","openapi":"api-reference/openapi-delegate.json GET /transcripts/account/{id}","href":"/delegate-access/api-reference/transcripts/account"}]},{"group":"TIN Verification","pages":[{"title":"Verify a TIN","openapi":"api-reference/openapi-delegate.json POST /tin-match/verify","href":"/delegate-access/api-reference/tin-match/verify"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/2026-10-23"}]}]},"title":"Look up client account by EIN - TaxRock API","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}