POST
/
authentication
curl --request POST \
  --url https://api.ding.live/v1/authentication \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "app_realm": "<string>",
  "app_version": "<string>",
  "callback_url": "<string>",
  "customer_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "device_id": "<string>",
  "device_model": "<string>",
  "device_type": "IOS",
  "ip": "127.0.0.1",
  "is_returning_user": true,
  "os_version": "<string>",
  "phone_number": "+1234567890"
}'
{
  "authentication_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "status": "pending"
}

Authorizations

x-api-key
string
headerrequired

Body

application/json
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.

app_version
string

The version of your app.

callback_url
string

A webhook URL to which delivery statuses will be sent.

customer_uuid
string
required

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

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_model
string

The model of the user's device.

device_type
enum<string>

The type of device the user is using.

Available options:
IOS,
ANDROID,
WEB
ip
string

The IP address of the user's device.

is_returning_user
boolean

Whether the user is a returning user on your app.

os_version
string

The version of the user's operating system.

phone_number
string
required

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

Response

200 - application/json
authentication_uuid
string

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

created_at
string
expires_at
string

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

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