Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
user_id
string
required

Id of the user to fetch

Body

application/json
​
1099_adjustment_2024
integer

Income paid outside of the Dots platform in 2024.

Required range: x > 1
​
auto_payout_enabled
boolean

Enables auto payout for the user whenever a default payout method is defined

​
date_of_birth
string

User's date of birth.

​
default_payout_method
enum<string>

Configures the user's default payout method. Must be a payout method already configured by the user.

Available options:
paypal,
venmo,
cash_app,
ach,
intl_bank
​
metadata
any

Arbitrary metadata

Response

200 - application/json

The user object.

​
compliance
object
​
default_payout_method
enum<string>
Available options:
ach,
paypal,
venmo,
cash_app,
intl_bank,
airtm,
payoneer
​
default_payout_method_details
object
​
email
string
​
first_name
string
​
id
string
​
last_name
string
​
metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
phone_number
object
​
status
enum<string>
Available options:
verified,
unverified,
disabled,
in_review
​
wallet
object
Delete a UserSubmit Compliance Information