Skip to main content
PATCH
/
v2
/
users
/
{user_id}
Update a user
curl --request PATCH \
  --url https://api.dots.dev/api/v2/users/{user_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "default_payout_method": "paypal",
  "auto_payout_enabled": true,
  "date_of_birth": "2023-12-25",
  "1099_adjustment_2024": 2,
  "metadata": "<unknown>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "phone_number": {
    "country_code": "<string>",
    "phone_number": "<string>"
  },
  "default_payout_method": "ach",
  "default_payout_method_details": {
    "platform": "ach",
    "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
  },
  "status": "verified",
  "compliance": {
    "tax_id_collected": true,
    "tax_id_verification": "unsubmitted",
    "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": {
      "entity_type": "individual",
      "business_name": "<string>",
      "tax_id_collected": true,
      "address_collected": true
    },
    "flags": {
      "ofac": true,
      "ofac_status": "unflagged",
      "payout_method": true,
      "payout_method_cycle": true,
      "name_mismatch": true
    }
  },
  "metadata": "<string>"
}

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
​
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

Response

200 - application/json

OK

The user object.

​
id
string<uuid>
​
first_name
string
​
last_name
string
​
email
string<email>
​
phone_number
object
​
default_payout_method
enum<string>
Available options:
ach,
paypal,
venmo,
cash_app,
intl_bank,
airtm,
payoneer
​
default_payout_method_details
object
​
wallet
object
​
status
enum<string>
Available options:
verified,
unverified,
disabled,
in_review
​
compliance
object
​
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.