Update a user

Update mutable fields of a user object.

PATCH /v2/users/{user_id}

Update a user

cURL

curl --request PATCH \
  --url https://api.dots.dev/api/v2/users/{user_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "auto_payout_enabled": true,
  "date_of_birth": "2023-12-25",
  "1099_adjustment_2024": 2,
  "metadata": "<unknown>",
  "payout_options_exclude_list": []
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "[e-mail]",
  "phone_number": {
    "country_code": "<string>",
    "phone_number": "<string>"
  },
  "default_payout_method_details": {
    "id": "<string>",
    "description": "<string>",
    "mask": "<string>",
    "email": "<string>",
    "phone_number": "<string>",
    "cash_tag": "<string>",
    "country": "<string>",
    "currency": "<string>",
    "rtp_enabled": true,
    "meta": "<unknown>"
  },
  "wallet": {
    "amount": 123,
    "withdrawable_amount": 123,
    "credit_balance": 123
  },
  "compliance": {
    "tax_id_collected": true,
    "address_collected": true,
    "date_of_birth_collected": true,
    "must_collect_1099": true,
    "1099_collected": true,
    "w8_ben_collected": true,
    "flagged": true,
    "id_verified": true,
    "has_criminal_activity": true,
    "w9": {
      "business_name": "<string>",
      "tax_id_collected": true,
      "address_collected": true
    },
    "flags": {
      "ofac": true,
      "payout_method": true,
      "payout_method_cycle": true,
      "name_mismatch": true
    }
  },
  "metadata": "<string>",
  "payout_options_exclude_list": []
}

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<uuid> · required

Id of the user to fetch

Body

application/json

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, airtm, payoneer, crypto

auto_payout_enabled · boolean

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

date_of_birth · string<date>

User's date of birth.

1099_adjustment_2024 · integer

Income paid outside of the Dots platform in 2024.

Required range: x >= 1

metadata · any

Arbitrary metadata

payout_options_exclude_list · enum<string>[]

Replace the user's payout exclude list. Pass [] to clear.

Available options: ach, paypal, venmo, cash_app, intl_bank, airtm, payoneer, crypto

Response

200 - application/json

OK

The user object.

id · string<uuid>

first_name · string

last_name · string

email · string<email>

phone_number · object

Show child attributes

default_payout_method · enum<string>

Available options: ach, paypal, venmo, cash_app, intl_bank, airtm, payoneer, crypto

default_payout_method_details · object

Show child attributes

wallet · object

Show child attributes

status · enum<string>

Available options: verified, unverified, disabled, in_review

compliance · object

Show child attributes

metadata · string object

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.

payout_options_exclude_list · enum<string>[]

Payout rails hidden from this user. Stacks with app-level exclusions.

Available options: ach, paypal, venmo, cash_app, intl_bank, airtm, payoneer, crypto