Get authentication status (V1 API)

Get authentication status

curl --request GET \
  --url https://api.ding.live/v1/authentication/{auth_uuid} \
  --header 'x-api-key: <api-key>'

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone_number": "<string>",
  "template_id": "<string>",
  "correlation_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "signals": {
    "ip": "127.0.0.1",
    "device_id": "<string>",
    "device_type": "ANDROID",
    "app_version": "<string>",
    "app_realm": "<string>",
    "os_version": "<string>",
    "device_model": "<string>",
    "is_returning_user": true
  },
  "events": [
    {
      "id": "<string>",
      "content": "<string>",
      "sender_id": "<string>",
      "capability": "rcs",
      "attempt_number": 123,
      "status": "pending",
      "type": "attempt",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

GET

authentication

{auth_uuid}

Get authentication status

curl --request GET \
  --url https://api.ding.live/v1/authentication/{auth_uuid} \
  --header 'x-api-key: <api-key>'

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone_number": "<string>",
  "template_id": "<string>",
  "correlation_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "signals": {
    "ip": "127.0.0.1",
    "device_id": "<string>",
    "device_type": "ANDROID",
    "app_version": "<string>",
    "app_realm": "<string>",
    "os_version": "<string>",
    "device_model": "<string>",
    "is_returning_user": true
  },
  "events": [
    {
      "id": "<string>",
      "content": "<string>",
      "sender_id": "<string>",
      "capability": "rcs",
      "attempt_number": 123,
      "status": "pending",
      "type": "attempt",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

The V1 API is deprecated. Technical support will end by October 2025 and will be removed by April 2026. No new features nor functionality will be added to the V1 API. Please use the V2 Verify API instead. For more information refer to the V2 Migration Guide.

Authorizations

x-api-key

string

header

required

Path Parameters

auth_uuid

string<uuid>

required

The UUID of the authentication.

Response

uuid

string<uuid>

The UUID of the corresponding authentication.

phone_number

string<phone_number>

An E.164 formatted phone number.

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.

created_at

string<date-time>

signals

object

Signals are data points used to distinguish between fraudulent and legitimate users.

Show child attributes

signals.ip

string<ipv4>

The IP address of the user's device.

signals.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.

signals.device_type

enum<string>

The type of device the user is using.

Available options:

ANDROID,

IOS,

IPADOS,

TVOS,

WEB

signals.app_version

string

The version of your application.

signals.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.

signals.os_version

string

The version of the user's device operating system.

signals.device_model

string

The model of the user's device.

signals.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.

events

(Attempt · object | Check · object | Delivery Status · object | Balance Update · object)[]

Represents a collection of events that occur during the authentication process. Each event captures specific actions and outcomes related to the authentication attempts, checks, delivery statuses, and balance updates. The array can contain different types of events, each with its own structure and properties.

Attempt
Check
Delivery Status
Balance Update

Show child attributes

events.id

string

The ID of the attempt.

events.content

string

The content of the attempt.

events.sender_id

string

The sender ID of the attempt.

events.capability

enum<string>

The capability of the attempt.

Available options:

rcs,

text,

whatsapp,

viber,

zalo,

telegram

events.attempt_number

integer

The attempt number.

events.status

enum<string>

The status of the attempt. Possible values are:

pending - The attempt is pending.
delivered - The attempt was delivered.
failed - The attempt failed.
rate_limited - The authentication was rate limited and cannot be retried.
expired - The authentication has expired and cannot be retried.

Available options:

pending,

delivered,

failed,

rate_limited,

expired

events.type

enum<string>

The type of the event.

Available options:

attempt,

check,

delivery_status,

balance_update

events.created_at

string<date-time>

Send feedback

Node.js

⌘I

Documentation

API Reference

SDKs

Authorizations

Path Parameters

Response