Users
Users
Users
Users
A user is a representation of a person or entity in the Dots system. A user can be created by a platform or by the user themselves but can be connected to any platform.
Each user is attached to a wallet which holds the user’s balance, transactions and credits.
The platform can add additional data to a user such as an SSN and address for tax purposes and add bank accounts and other payment methods.
The User Object
Example
{
"id": 12341341,
"email": "test@senddots.com",
"username": "bob-loblaw",
"first_name": "Bob",
"last_name": "Loblaw",
"display_name": "Bob Loblaw",
"wallet": {
"amount": 1000.0,
"withdrawable_balance": 500.0,
"credit_balance": 0
},
"ach_accounts": [
{
"name": "Chase Checking",
"id": "acc_32234dfs235",
"mask": "2345"
}
]
}
Attributes
| Name | Type | Description |
|---|---|---|
id | string (uuid) | UUID id of the user |
first_name | string | User’s first name |
last_name | string | User’s last name |
username | string | User’s username |
display_name | string | User’s display name |
wallet | object | — |
wallet.amount | float | Amount of dots in the user’s wallet |
wallet.credit_balance | float | Amount of credit for your app in the user’s wallet |
wallet.withdrawable_balance | float | Amount of dots that user can withdraw from their wallet |
ach_accounts | array | Array of ACH accounts |
ach_accounts.name | string | Name of the ACH account |
ach_accounts.id | string | ID of the ACH account |
ach_accounts.mask | string | Last 4 digits of the ach account |