Skip to main content
POST
/
v1
/
auth
/
otps
/
sms
/
login_or_create
Login or Create User by SMS
curl --request POST \
  --url https://api.streambird.io/v1/auth/otps/sms/login_or_create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone_number": "+14152222222",
  "expires_in": 3
}'
{
  "phone_number_id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
  "user_created": false,
  "status": "pending",
  "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2"
}

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
​
phone_number
string
required

E.164 formatted mobile phone number that uniquely identifies the user.

Minimum length: 1
​
expires_in
number

Expiration time of the OTP in minutes. Must be between 1 to 10 minutes, defaults to 1 minute.

​
requires_verification
boolean

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

​
device_fingerprint
object

Device fingerprinting metadata for fraud detection during verification step. This is useful to ensure that the user who originated the request matches the user that verifies the token. Verification requirements can be enabled in the Verify OTP step by matching fields in the device_fingerprint such as IP, User Agent or the combination of them (more fraud detection features coming soon!)

Response

200 - application/json

OK

​
phone_number_id
string
required
Minimum length: 1
​
user_created
boolean
required
​
user_id
string
required
Minimum length: 1
​
status
string
required