GET
/
tax-payer
curl --request GET \
  --url https://api.trychart.com/tax-payer \
  --header 'Authorization: Bearer <token>'
{
  "id": "clxjfvx74000f11di1uq2u8xm",
  "name": "Joe Doe",
  "metadata": {},
  "provider_id": "irs-tax-pro",
  "created_at": "2024-06-17T20:40:03.965Z",
  "status": "TAX_AUTHORIZATION_SUBMITTED",
  "analysis": {
    "total_liabilities": "5000",
    "liabilities_with_lien_filed": "3000"
  },
  "details": {
    "address": {
      "street_address": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "zip_code": "94101"
    },
    "balance_summary": {
      "balance_due": 5000,
      "tax_years": [
        {
          "amount": 2500,
          "year": "2023"
        }
      ]
    }
  },
  "form8821": "<string>"
}

Authorizations

​
Authorization
string
header
required

Please use your access_token returned from the /auth/token endpoint.

Response

200 - application/json
Introspect Response
​
id
string
required

The Chart UUID of the taxpayer. Returned from the /auth/token endpoint.

Example:

"clxjfvx74000f11di1uq2u8xm"

​
name
string
required
Example:

"Joe Doe"

​
provider_id
enum<string>
required
Available options:
turbotax,
hr,
taxact,
tax_slayer,
jackson,
free_tax_usa,
irs,
irs_tax_pro,
pilot,
cch_axcess,
drake,
proconnect,
chart-sandbox
Example:

"irs-tax-pro"

​
created_at
string
required
Example:

"2024-06-17T20:40:03.965Z"

​
status
enum<string>
required
Available options:
CREATED,
CONSENT_RECEIVED,
TAX_AUTHORIZATION_SUBMITTED,
AUTHORIZED,
REJECTED,
COMPLETED
Example:

"TAX_AUTHORIZATION_SUBMITTED"

​
metadata
object

Custom metadata identifying external fields about the taxpayer.

​
analysis
object

Aggregated analysis of the taxpayer's tax situation across all tax records.

​
details
object

Taxpayer's account details depending on the provider.

​
form8821
string

A pre-signed URL pointing to the raw IRS Form 8821 file retrieved from the provider. Returns a PDF file. The URL expires after 12 hours.

Was this page helpful?

Get RecordRefresh Taxpayer