Skip to content
DocumentationSign in

Statement and balance

All routes in this section work with the same key you use to send codes.

Session list

GET /v1/verifications returns an array of sessions, newest first.

Parameter Value
status pending, verified, failed or expired
channel The channel that delivered the code: telegram, whatsapp or sms
q vrf_…, part of a number or correlation_id
limit From 1 to 100, default 50
before Cursor, a time in RFC 3339 format

For the next page, set before to the created_at value of the last row.

GET /v1/verifications.csv accepts the same filters and returns up to 10,000 rows: ; delimiter, UTF-8 encoding with BOM.

Session details

GET /v1/verifications/{id} shows the session and the code’s path through the channels:

{
  "id": "vrf_8c1f04a2b7d93e6f5a10",
  "phone": "+77011234567",
  "status": "verified",
  "purpose": "login",
  "checks": 1,
  "cost_tiyn": 1400,
  "created_at": "2026-11-08T10:00:00Z",
  "expires_at": "2026-11-08T10:05:00Z",
  "verified_at": "2026-11-08T10:00:41Z",
  "test": false,
  "correlation_id": "order-42",
  "attempts": [
    {"channel": "telegram", "status": "undeliverable", "cost_tiyn": 0, "error": "PHONE_NUMBER_NOT_FOUND", "created_at": "2026-11-08T10:00:00Z", "updated_at": "2026-11-08T10:00:02Z"},
    {"channel": "whatsapp", "status": "delivered", "cost_tiyn": 1400, "created_at": "2026-11-08T10:00:02Z", "updated_at": "2026-11-08T10:00:05Z"}
  ]
}

The text in error comes from the provider and may change, so do not build logic on it. Optional fields appear only if they have a value: verified_at, ip, ip_country, device, locale, preferred_channel, correlation_id.

Statistics

GET /v1/stats?days=14 returns totals for a period of 1 to 90 days: verifications, verified, delivered, spent_tiyn, saved_vs_sms_tiyn, and the channels and daily breakdowns.

Balance and invoices

GET /v1/billing/balance:

{"balance_tiyn": 1250000, "balance_kzt": "12500.00"}

POST /v1/billing/invoices with the body {"amount_kzt": 50000} issues an invoice for an amount from 5,000 ₸ to 50,000,000 ₸. GET /v1/billing/invoices returns the last 50 invoices.