Get User by ID

Get a user by their id.

GET /v2/users/{user_id}

Try it

Retrieve a User

cURL

curl --request GET \
  --url https://api.dots.dev/api/v2/users/{user_id} \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "[e-mail]",
  "phone_number": {
    "country_code": "<string>",
    "phone_number": "<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 · 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

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

phone_number. country_code · string

phone_number. phone_number · string

wallet · object

Show child attributes

wallet. amount · integer

wallet. withdrawable_amount · integer

wallet. credit_balance · integer

compliance · object

Show child attributes

compliance. tax_id_collected · boolean

compliance. address_collected · boolean

compliance. date_of_birth_collected · boolean

compliance. must_collect_1099 · boolean

compliance. 1099_collected · boolean

compliance. w8_ben_collected · boolean

compliance. flagged · boolean

compliance. id_verified · boolean

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.