POST
/
authentication

Authorizations

x-api-key
string
headerrequired

Body

application/json
customer_uuid
string
required

Your customer UUID, which can be found in the API settings in the dashboard.

phone_number
string
required

An E.164 formatted phone number to send the OTP to.

ip
string

The IP address of the user's device.

device_id
string

Unique identifier for the user's device. For Android, this corresponds to the ANDROID_ID and for iOS, this corresponds to the identifierForVendor.

device_type
enum<string>

The type of device the user is using.

Available options:
IOS,
ANDROID,
WEB
app_version
string

The version of your application.

callback_url
string

A webhook URL to which delivery statuses will be sent.

app_realm
string

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.

os_version
string

The version of the user's device operating system.

device_model
string

The model of the user's device.

is_returning_user
boolean

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.

template_id
string

The template id associated with the message content variant to be sent.

correlation_id
string

A unique, user-defined identifier that will be included in webhook events

Response

200 - application/json
authentication_uuid
string

A unique identifier for the authentication that you can use on the /check and /retry endpoints.

status
enum<string>

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.
Available options:
pending,
rate_limited,
spam_detected
created_at
string
expires_at
string

The time at which the authentication expires and can no longer be checked or retried.

Was this page helpful?

ErrorsCheck a code