Users
Within the TaxBit ecosystem, User
represents an account owned by an end user, which includes Personal Identifiable Information (PII) data and transaction records associated with that account.
While no specific field is mandatory to establish a User
in our system, certain fields like tax_id
are necessary for features like Information Reporting and Withholding (IRW) Form Generation and Automatic TIN Validation. The fields you incorporate will depend significantly on your specific use case. Nonetheless, it is advised to provide as much data as feasible regarding a User
as a best practice to ensure that TaxBit possesses the required information to satisfy your regulatory requirements.
User Data Model
Field Name | Data Type | Description |
---|---|---|
uuid | UUID | Unique ID of a user |
external_id | string | ID for the user in the source system. This ID is used to identify the user outside of the TaxBit platform and is used for tax form generation. |
account_owner_id | string | ID of the AccountOwner related to this user |
payer_id | string | ID of the payer/filer for this user |
user_type | string enum | User account type [INDIVIDUAL, BUSINESS, UNKNOWN, US_IRA_TRADITIONAL, US_IRA_ROTH, US_IRA_SEP, US_IRA_SIMPLE] |
name | string | User's full name |
email | string | User's email address |
address | UserAddress | User's address |
country_code | string | Country the user is subject to taxes. View full list of alpha-2 country codes here. |
tax_id | string | Unmasked TIN |
tax_id_type | string enum | TIN Type [US_SSN, US_ITIN, US_EIN, NON_US_TIN] |
birth_date | string | User's date of birth |
establishment_date | string | Date when account was established |
year_end_fair_market_value | [YearEndFairMarketValue] | Array of year-end fair market values. Not required for user creation, but required to generate forms for users of type US_IRA_TRADITIONAL, US_IRA_ROTH, US_IRA_SEP, and US_IRA_SIMPLE. |
physical_mail | boolean | Whether the user's tax forms will be sent through physical mail instead of electronically. Defauls to false. |
UserAddress Object
Field Name | Data Type | Description |
---|---|---|
first_line | string | First line of user's address |
second_line | string | Second line of user's address |
third_line | string | Third line of user's address |
city | string | User's city |
state | string | User's state |
country | string | User's country |
postal_code | string | User's postal code |
YearEndFairMarketValue
Field Name | Data Type | Description |
---|---|---|
year_end | number | Four digit year of the last tax year as of 12/31 |
fair_market_value | AssetQuantity | Total US dollar value of assets within the account at year-end |
required_minimum_distributions | AssetQuantity | Total US dollar amount that must be withdrawn annually from a retirement account (IRA) by owners of retirement age |
AssetQuantity
Field Name | Data Type | Description |
---|---|---|
asset | Asset | Asset object |
quantity | number | Quantity of the given asset |