Skip to main content
POST
/
v1
/
auth
/
users
/
create
Create User
curl --request POST \
  --url https://api.streambird.io/v1/auth/users/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "John",
  "last_name": "Smith",
  "email": "sandbox@streambird.io",
  "phone_number": "+14152222222",
  "requires_verification": true
}'
{
  "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
  "status": "pending",
  "email_id": "email_24oXBL3PufzHkH1Jzyjc2EXYeo7",
  "phone_number_id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy"
}

Authorizations

​
Authorization
string
header
required

Auth Platform API includes all the Auth related features. All Users, Phone Numbers, Emails, and OTPs are associated with an App as the container.

Endpoints only accept App's Secret API keys other than certain endpoints that are used client side or via SDK that accept the public_token.

Authentication using App Api Key

Header:

Authorization: Bearer {api_key}

Authenticated Request

curl \
  -X GET https://api.streambird.io/v1/auth/users/user_24wFP9pDa9YiMJLun94iKykoZs2 \
  -H "Authorization: Bearer sk_test_pRqweh3wvWmJAAVYv7Z0T5iPLzFM4ql0muoyQcjOxGeN3p1r"

Body

application/json
​
email
string

Required if phone_number not present Email that uniquely identifies the user.

Minimum length: 1
​
phone_number
string

Required if email not present E.164 formatted mobile phone number that uniquely identifies the user.

Minimum length: 1
​
first_name
string

First name of the user.

Minimum length: 1
​
middle_name
string

Middle name of the user.

​
last_name
string

Middle name of the user.

​
requires_verification
boolean

Determines if verification for the authentication method (email, phone_number) is required before marking the user as active.

​
wallet_type
string

Determines what type of wallet login. If the user does not have a default wallet of the same wallet_type, a new default wallet will be created for the user. If left blank, the default will be ethereum. Possible values: ethereum, solana, bitcoin, DOT, XLM (more wallets coming soon).

​
include_user
boolean

Determines if the full user object should be returned. Defaults to false.

Response

200 - application/json

Create User response

​
user_id
string
required
Minimum length: 1
​
status
string
required
​
email_id
string
required
Minimum length: 1
​
phone_number_id
string
required
Minimum length: 1
​
user
object