Getting Started with Uvio Notify

Register your company, connect to the LK Dashboard, and call the Notify API within minutes.

Need deeper details? Open the API Reference for the full OpenAPI schema and up-to-date endpoint list.

Overview

Uvio Notify lets your product send secure OTP requests and transactional notifications to verified Uvio users. This guide walks through the requirements, Dashboard flow, and the minimal API call you need to validate the integration.

Prerequisites

Before You Begin

Make sure you have the following:

  • An active Uvio mobile app account. Download the app from the App Store (soon) or RuStore (soon) and complete onboarding.
  • A work email that matches your Uvio account plus your company tax ID (12 digits) and website.
  • Company documents for the registration form: charter + representative authorization for legal entities, or passport scan + entrepreneur card for sole proprietors.

Step 1: Register Your Company

Head to the LK Dashboard at https://lk.uvio.chat/register and follow the guided registration wizard.

1

Open the LK Dashboard

Visit https://lk.uvio.chat/register in a modern desktop browser.

2

Fill in Company Details

Provide the company name, 12-digit tax ID, website, and the work email tied to your Uvio mobile app profile.

3

Confirm OTP

Approve the six-digit OTP that arrives in the Uvio mobile app (codes expire in 10 minutes).

4

Upload Documents

Upload the required company documents (PDF/DOC/DOCX) before submitting the form.

Document Checklist

The registration form cannot be submitted without the following files:

  • Legal entity: company charter + representative authorization document.
  • Sole proprietor: passport scan + entrepreneur registration card.

Files are reviewed manually. Make sure scans are readable and match the tax ID entered earlier.

Step 2: Access the LK Dashboard

After approval, sign in at https://lk.uvio.chat. Authentication is OTP-based, so you never need a password.

Login Process

1

Enter Your Email

Go to the login page and enter the email that was verified during registration.

2

Receive OTP

An OTP code is pushed to the Uvio mobile app on your phone.

3

Verify & Access the Admin Panel

Enter the OTP within 10 minutes to unlock the admin panel and manage your company.

Step 3: Find Your Company ID

Your Company ID is a unique UUID assigned during registration. You'll need this ID for certain API operations.

From Dashboard

Once logged into the LK Dashboard:

  1. Navigate to Settings → Company Profile
  2. Your Company ID is displayed at the top of the page
  3. Click the Copy button to copy it to your clipboard
Company ID Format 
550e8400-e29b-41d4-a716-446655440000
Pro Tip
Store your Company ID in your environment variables or configuration file for easy access in your code.

Step 4: Generate Your API Key

API keys authenticate your application when calling the Uvio Notify API. Each key is scoped to your company and maps to the X-API-Key header described in the OpenAPI specification.

Generate via Dashboard

  1. Login to the LK Dashboard (https://lk.uvio.chat)
  2. Navigate to Settings → API Keys
  3. Click Generate New API Key
  4. Important: Copy the key immediately - it will only be shown once!
  5. Store it securely (environment variables, secrets manager, etc.)

Every API request must include X-API-Key: YOUR_SECRET_KEY. Requests missing that header return 401 Unauthorized.

API Key Format 
sk_live_abc123def456ghi789jkl012mno345pqr678stu901
Security Warning
  • Never commit API keys to version control
  • Store keys in environment variables or secure vaults
  • Rotate keys regularly and after any suspected compromise
  • Each API key can only be viewed once at creation time
  • If you lose a key, revoke it and generate a new one

Default Permissions

New API keys are created with the following permissions:

  • notifications:send - Send push notifications
  • notifications:read - View notification status and history
  • subscribers:read - Access subscriber information

Step 5: Make Your First API Call

The Notify API is hosted at https://api.uvio.chat/notify/v1. Below is the minimal call to POST /notifications/send that is documented in /static/openapi/notify/v1/openapi.yaml.

cURL 
curl -X POST https://api.uvio.chat/notify/v1/notifications/send \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sk_live_your_secret_key" \
  -d '{
    "title": "Test notification",
    "body": "Sent from the LK Dashboard onboarding flow.",
    "priority": "regular",
    "target": {
      "all_subscribers": true,
      "user_emails": []
    }
  }'
Success 200 OK 
{
  "notification_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "created_at": "2024-11-01T10:00:00Z",
  "estimated_recipients": 125,
  "quota_info": {
    "limit": 1000,
    "used": 1,
    "remaining": 999
  }
}
Track Delivery
Use GET /notifications/{notification_id}/status with the same base URL and X-API-Key header to poll delivery status. For a complete list of fields and other endpoints, open the API Reference.

Understanding Company Tiers

Your company is assigned a tier that determines your notification quota and features:

Free
1,000
notifications/month
Default tier for new companies
Basic
10,000
notifications/month
For growing businesses
Pro
100,000
notifications/month
For established companies
Enterprise
Unlimited
notifications/month
Custom solutions
Quota Tracking
Each response from POST /notifications/send now embeds quota usage inside the JSON payload under quota_info:
Response Fragment 
{
  "quota_info": {
    "limit": 1000,
    "used": 42,
    "remaining": 958
  }
}
  • limit — monthly notification allowance for your tier.
  • used — number of notifications already sent this period.
  • remaining — what you still can send before throttling.

When quota reaches zero, the API returns 402 Payment Required and no new notifications are accepted.

Next Steps

Now that you have your API credentials, explore what you can build with the LK Dashboard and Notify API:

Create Events

Learn how to create and manage events for your users

Send Notifications

Push notifications to your users across all devices

OTP Authentication

Integrate secure OTP login into your website

API Reference

Complete API documentation with all endpoints