Request Path

Submit all wealth requests to the following path.

You will obtain the API endpoint after you register on your account page.

Headers

Each request must an Oauth2 tokan and your company Id, assigned by TaxStatus, in the header.

Query String Parameters

Query string parameters are not supported on this method.

/Wealth Request application/json

This method uses the Tax Identification Number (TIN) for an individual, which is their SSN, to retrieve all relevant income, asset, and investment information.

Attributes

• companyId* The company Id of the company this call is on behalf of. If the call is not on behalf of another company, then the registered company Id TaxStatus assigned during the registration process (used in the euid field in the header.
• tin* 9-digit tax id (SSN - no spaces or hypens) of the individual taxpayer

Example call request body for the wealth method

Response Body application/json

The following is a list of all possible fields.

Attributes

• TIN The last 4 digits of the SSN sent in the request.
• FullName The full name of the individual sent in the request
• TaxYear The tax year with which the data pertains.
  • EmploymentIncome Array of all the employment income.
    • Payer Employer name
    • GrossIncome Annual gross income
    • IncomeTax If available, the tax assested for the tax year
    • EmployerBenefitComp If available, any employee compensation received
  • SelfEmploymentIncome Array of all the self employment (Schedule C).
    • Business Business name (may be redacted)
    • GrossIncome Annual gross income
    • NetIncome If available, the net income for the tax year
    • NEtProfitOrLoss If available, the net profit or loss for the tax year
  • BusinessIncome Array of business income
    • Business Business name
    • Source The form the income was sourced from
    • Revenue If available, the revenue from this source
    • Income The income from this business for the tax year
    • Losses The losses from this business for the tax year
  • CashInvestmentIncome Array of cash and investment income
    • Location Name of the investment or investment house
    • Interest The interest generated for the tax year
    • Dividend The dividens paid for the tax year
    • Trades Trades made on this investment for the tax year
    • NetProceeds The net proceeeds for the tax year
  • CashInvestmentAccounts Array of investment accounts
    • Location Name of the investment or investment house
    • Account If available, the last 4 characters of the account number
    • Interest The interest generated for the tax year
    • Dividend The dividens paid for the tax year
  • RetirementAndTaxAdvantageAccounts Array of retirement accounts
    • Location Name of the investment or investment house
    • Account If available, the last 4 characters of the account number
    • Type The retirement account type
    • Contributions Contributions made for the tax year
    • FMV Fair Market Value of the account
  • RealEstate Array of real estate holdings
    • Address Street address of the property
    • City City State Zip
    • MTG
    • Principle Remaining amount owed on the loan
    • EstValue If available, the estimated value of the preperty
    • EstEquity If available, the amount of equity on the property

Example response bodys for the wealth method

Example response when taxpayer is not in the system.

The possible reponse codes are below.

Response Codes