---
title: "Get list of users' annual balance"
method: GET
path: "/payout/tax"
tags: ["Tax"]
---

# Get list of users' annual balance

`GET /payout/tax`

This **GET**  endpoint is used to get tax information for a specific user identified by their `user_token`. It provides access to historical tax attribute values as well as the ability to perform attribute velocity checks. <br>  To use this endpoint, replace `user_token` in the URL path with the actual user token of the user whose tax information you want to retrieve. This endpoint's purpose is to aid in the identification of users with matching attribute values and to prevent fraudulent activities by monitoring unusual attribute value changes over time. It compares the provided attribute value to the historical attribute values for the same user to see if it meets the velocity check criteria.

## Query parameters

- `amount_threshold` number, required
- `tax_year` integer, required
- `user_token` string, uuid

## Response `200`

Succesful operation.

- TaxYearUserResp[]
  - `user_token` string — The user token that needs to be fetched.
  - `address1` string, required — The user's street address.
  - `address2` string — The user's street address, line 2.
  - `city` string, required — The user's city.
  - `state_province` string — The user's state/province.
  - `postal_code` number — The user's postal code.
  - `country` string, required — The user's country code. [ISO_3166-1_alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) code.
  - `first_name` string, required — The user's first name. If Business account, the first name of the representative.
  - `middle_name` string — The user's middle name. If Business account, the middle name of the representative.
  - `last_name` string, required — The user's last name. If Business account, the last name of the representative.
  - `email` string — The user's e-mail address. Must be unique. Cannot have two users with the same e-mail address.
  - `mobile_number` string — Mobile phone number in [international format](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers#).
  - `business_name` string — Name of business
  - `date_of_birth` string, date, required — Date of birth. Minimum 18 years old.
  - `balance` number, required — Current user balance
  - `payout_count` integer — Total count of payouts
  - `tax_id` string — User Tax ID. This can be a Taxpayer Identification Number (TIN), Social Security Number (SSN), Individual Taxpayer Identification Number (ITIN) or Employer Identification Number (EIN).

## Other responses

- `400` — Bad request.
- `401` — Unauthorized.
- `403` — Forbidden.
- `404` — Not Found
- `405` — Method Not Allowed.
- `500` — Internal server error.
- `504` — Gateway Time-out.

---

[API](https://skmtc.net/masspay/apis/masspay-api.md) · [All operations](https://skmtc.net/masspay/apis/masspay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/masspay/masspay-api/versions/c03b61a6a551/schema)
