TRtrychart

GET /tax-payer

Retrieve taxpayer information associated with an access_token.

Request

  • Base URL
    https://api.trychart.com
  • Auth
    HTTP bearer

Response

Introspect Response

idstring required

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

namestring required
metadataobject

Custom metadata identifying external fields about the taxpayer.

provider_id'turbotax' | 'hr' | 'taxact' | 'tax_slayer' | 'jackson' | 'free_tax_usa' | 'irs' | 'irs_tax_pro' | 'pilot' | 'cch_axcess' | 'drake' | 'proconnect' | 'chart-sandbox' required
created_atstring date-time required
status'CREATED' | 'CONSENT_RECEIVED' | 'TAX_AUTHORIZATION_SUBMITTED' | 'AUTHORIZED' | 'REJECTED' | 'COMPLETED' required
form8821string

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.

Example response

{
  "id": "clxjfvx74000f11di1uq2u8xm",
  "name": "Joe Doe",
  "provider_id": "irs-tax-pro",
  "created_at": "2024-06-17T20:40:03.965Z",
  "status": "TAX_AUTHORIZATION_SUBMITTED",
  "analysis": {
    "tin": "123456789",
    "employment_history": [
      {
        "type": "WAID",
        "year": "2023",
        "employer": {
          "ein": "XXXXX2003",
          "name": "CHAR",
          "address": "609 WA"
        }
      }
    ]
  },
  "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"
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.