Skip to main content
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": "+1234567890",
  "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": "Your code is 123456",
      "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

OK

​
uuid
string<uuid>

The UUID of the corresponding authentication.

​
phone_number
string<phone_number>

An E.164 formatted phone number.

Examples:

"+1234567890"

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

​
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