Body
-
E.164 formatted mobile phone number that uniquely identifies the user.
Minimum length is
1
. -
Expiration time of the OTP in minutes. Must be between 1 to 10 minutes, defaults to 1 minute.
-
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 thedevice_fingerprint
such as IP, User Agent or the combination of them (more fraud detection features coming soon!)
POST
/v1/auth/otps/sms/send
curl \
--request POST 'https://api.streambird.io/v1/auth/otps/sms/send' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"expires_in":3,"phone_number":"+14152222222"}'
Request example
{
"expires_in": 3,
"phone_number": "+14152222222"
}
Response examples (200)
{
"user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
"phone_number_id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy"
}