curl --request POST \
  --url https://api.dots.dev/api/v2/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "Bob",
  "last_name": "Loblaw",
  "email": "bob@bobloblaw.com",
  "country_code": "1",
  "phone_number": "4154332334",
  "metadata": {
    "internal_id": "user_121344"
  }
}'
{
  "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": {
    "id": "<string>",
    "platform": "ach",
    "description": "<string>",
    "mask": "<string>",
    "email": "<string>",
    "phone_number": "<string>",
    "cash_tag": "<string>",
    "country": "<string>",
    "currency": "<string>"
  },
  "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
  },
  "metadata": "<string>"
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
first_name
string
required

The user's first name.

last_name
string
required

The user's last name.

email
string
required

The user's email address.

country_code
string
required

The user's phone number country code. e.g. "1"

phone_number
string
required

The user's phone number. e.g. "4157223331".

username
string

Username to assign the user.

date_of_birth
string

User's date of birth.

1099_adjustment_2024
integer

Income paid outside of the Dots platform in 2024.

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.

Response

200 - application/json
id
string
first_name
string
last_name
string
email
string
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
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.