Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB
Tax

Get list of users' annual balance

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.

get/payout/tax

Query parameters

amount_thresholdnumber required

If specified, only show users whose total balance exceeds the provided amount

tax_yearinteger required

The year for which we would like to obtain tax information for. If none provided, defaults to previous year.

user_tokenstring uuid
Example:usr_aac401aa-6e5e-4af4-bcc1-2e06c18a4735,usr_2baa773a-9ce6-401a-944b-dd95098e6730

Optional user token. When provider, it will return the tax amount for the provided users. For more than one user, provided the tokens comma separated.

Response

Succesful operation.

user_tokenstring

The user token that needs to be fetched.

address1string required

The user's street address.

address2string

The user's street address, line 2.

citystring required

The user's city.

state_provincestring

The user's state/province.

postal_codenumber

The user's postal code.

countrystring required

The user's country code. ISO_3166-1_alpha-3 code.

first_namestring required

The user's first name. If Business account, the first name of the representative.

middle_namestring

The user's middle name. If Business account, the middle name of the representative.

last_namestring required

The user's last name. If Business account, the last name of the representative.

emailstring

The user's e-mail address. Must be unique. Cannot have two users with the same e-mail address.

mobile_numberstring

Mobile phone number in international format.

business_namestring

Name of business

date_of_birthstring date required

Date of birth. Minimum 18 years old.

balancenumber required

Current user balance

payout_countinteger

Total count of payouts

tax_idstring

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).

Example response

[
  {
    "user_token": "123e4567-e89b-12d3-a456-426614174000",
    "address1": "2000 main st",
    "address2": "apt D",
    "city": "Santa Monica",
    "state_province": "CA",
    "postal_code": 90405,
    "country": "USA",
    "first_name": "John",
    "last_name": "Doe",
    "email": "jdoe@gmail.com",
    "mobile_number": "16502000226",
    "business_name": "ABC Company",
    "date_of_birth": "1975-03-24",
    "balance": 1500,
    "tax_id": "123-45-678"
  }
]