Send a code
Authorizations
Body
Your customer UUID, which can be found in the API settings in the dashboard.
An E.164 formatted phone number to send the OTP to.
The IP address of the user's device.
Unique identifier for the user's device. For Android, this corresponds to the ANDROID_ID and for iOS, this corresponds to the identifierForVendor.
The type of device the user is using.
IOS, ANDROID, WEB The version of your application.
The Sender ID to use when sending the message.
A webhook URL to which delivery statuses will be sent.
The Android SMS Retriever API hash code that identifies your app. This allows you to automatically retrieve and fill the OTP code on Android devices.
The version of the user's device operating system.
The model of the user's device.
This signal should do more than just confirm if a user is returning to your app; it should provide a higher level of trust, indicating that the user is genuine. For more details, refer to Signals.
The template id associated with the message content variant to be sent.
A unique, user-defined identifier that will be included in webhook events
A BCP-47 locale indicating the language the SMS should be sent to; if this is not set, the SMS will be sent to the language specified by the country code of the message. If we don't support the language set, the message will be sent in US English (en-US).
Response
A successful response to an authentication creation request.
A unique identifier for the authentication that you can use on the /check and /retry endpoints.
The status of the authentication. Possible values are:
pending- The OTP code is being sent.rate_limited- This user is rate-limited and cannot receive another code.spam_detected- This attempt is flagged as spam. Go to the dashboard for more details.
pending, rate_limited, spam_detected The time at which the authentication expires and can no longer be checked or retried.
Was this page helpful?