User Routes
Create User
Create a user.
POST
/
v2
/
users
Authorization
Body
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/users \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"country_code": "<country_code>",
"email": "<email>",
"first_name": "<first_name>",
"last_name": "<last_name>",
"phone_number": "<phone_number>"
}'
{
"compliance": {
"1099_collected": "boolean",
"address_collected": "boolean",
"date_of_birth_collected": "boolean",
"flagged": "boolean",
"id_verified": "boolean",
"must_collect_1099": "boolean",
"tax_id_collected": "boolean",
"w8_ben_collected": "boolean"
},
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"metadata": [
"string",
"object",
"null"
],
"phone_number": {
"country_code": "string",
"phone_number": "string"
},
"wallet": {
"amount": "integer",
"credit_balance": "integer",
"withdrawable_amount": "integer"
}
}
Authorizations
Authorizationheaderrequired
string
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
application/json
country_coderequired
string
The user's phone number country code. e.g. "1"
emailrequired
string
The user's email address.
first_namerequired
string
The user's first name.
last_namerequired
string
The user's last name.
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.
phone_numberrequired
string
The user's phone number. e.g. "4157223331".
username
string
Username to assign the user.
Response
200 - application/json
compliance
object
email
string
first_name
string
id
string
last_name
string
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.
phone_number
object
wallet
object
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/users \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"country_code": "<country_code>",
"email": "<email>",
"first_name": "<first_name>",
"last_name": "<last_name>",
"phone_number": "<phone_number>"
}'
{
"compliance": {
"1099_collected": "boolean",
"address_collected": "boolean",
"date_of_birth_collected": "boolean",
"flagged": "boolean",
"id_verified": "boolean",
"must_collect_1099": "boolean",
"tax_id_collected": "boolean",
"w8_ben_collected": "boolean"
},
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"metadata": [
"string",
"object",
"null"
],
"phone_number": {
"country_code": "string",
"phone_number": "string"
},
"wallet": {
"amount": "integer",
"credit_balance": "integer",
"withdrawable_amount": "integer"
}
}