Кодты сұрау және тексеру

Кодты сұрау

POST /v1/verify сессия жасайды және кодты жіберу кезегіне қояды. Жауап 201. Тек phone өрісі міндетті.

{
  "phone": "+77011234567",
  "purpose": "login",
  "signals": {
    "ip": "95.56.1.1",
    "device_id": "3f2c9a71",
    "device_platform": "ios",
    "device_model": "iPhone 16",
    "os_version": "26.1",
    "app_version": "2.4.0",
    "user_agent": "MyApp/2.4.0",
    "is_trusted_user": false
  },
  "options": {
    "locale": "ru",
    "code_size": 4,
    "preferred_channel": "telegram"
  },
  "metadata": { "correlation_id": "order-42" }
}

Өріс	Мәндері
`phone`	Қазақстанның ұялы нөмірі: `+77XXXXXXXXX`, `77…` немесе `87…`. Бос орын, жақша және дефис қолдануға болады
`purpose`	`login` (әдепкі) немесе `registration`
`signals.ip`	Пайдаланушының IPv4 немесе IPv6 мекенжайы
`signals.device_id`	Құрылғы идентификаторы, 128 таңбаға дейін
`signals.device_platform`	`android`, `ios` немесе `web`
`signals.device_model`	64 таңбаға дейін
`signals.os_version`, `signals.app_version`	32 таңбаға дейін
`signals.user_agent`	300 таңбаға дейін
`signals.is_trusted_user`	`true` мәні нөмірге арналған сессия лимитін және аккаунтыңыздың антифрод ережелерін алып тастайды
`options.locale`	Хабарлама тілі: `ru` (әдепкі), `kk` немесе `en`
`options.code_size`	Код ұзындығы, 4-тен 8 санға дейін. Аккаунт баптауының орнына қолданылады
`options.custom_code`	Кездейсоқ кодтың орнына 4–8 саннан тұратын өз кодыңыз
`options.preferred_channel`	`telegram`, `whatsapp` немесе `sms` арнасынан бастау. Толығырақ — арналар бөлімінде
`metadata.correlation_id`	Сіздің идентификаторыңыз, 80 таңбаға дейін. Үзінді көшірмеге, CSV-ге және вебхуктарға түседі

signals деректері болса, оларды беріңіз: антифрод лимиттерді IP және құрылғы бойынша есептейді, ал оларсыз бұл ережелер жұмыс істемейді. Ұзын мәтіндік сигналдар қысқартылады, сұрау олардың кесірінен қабылданбай қалмайды.

Жауап:

{"id": "vrf_8c1f04a2b7d93e6f5a10", "status": "pending", "expires_at": "2026-11-08T10:05:00Z"}

Тест нөмірі үшін жауапта қосымша "test": true болады. Бұл жауапта арна жоқ: оны VERYO кейін таңдайды.

Кодты тексеру

POST /v1/verify/check сессияның id мәнін және пайдаланушы енгізген code мәнін қабылдайды. Жауап 200.

{"id": "vrf_8c1f04a2b7d93e6f5a10", "code": "1234"}

{"id": "vrf_8c1f04a2b7d93e6f5a10", "status": "verified", "channel": "telegram"}

`status`	Мағынасы	Не істеу керек
`pending`	Код қате, әрекеттер қалды	Кодты қайта енгізуді сұрау
`verified`	Код расталды. Қайта шақырғанда да `verified` қайтарылады	Пайдаланушыны өткізу
`failed`	Енгізу әрекеттері немесе жеткізу арналары таусылды	Жаңа код сұрау
`expired`	Кодтың мерзімі өтті	Жаңа код сұрау

channel — кодты жеткізген арна: telegram, whatsapp немесе sms. Код жеткізілгенге дейін және тест нөмірлерінде бұл өріс болмайды.

Басқа аккаунттың сессиялары мен жоқ id мәндері 404 not_found қайтарады.

Код баптаулары

Әдепкі мәндер кабинеттегі Код және SMS бөлімінде өзгертіледі.

Баптау	Ауқым	Әдепкі мән
Код ұзындығы	4–8 сан	4
Жарамдылық мерзімі	1–30 минут	5 минут
Енгізу әрекеттері	1–10	3
Нөмірге арналған сессиялар	1–50	4
Сессия лимитінің терезесі	1–168 сағат	72 сағат
Жаңа сұрау кезінде бұрынғы кодтың күшін жою	иә немесе жоқ	жоқ

Қайта жіберу

Кодты қайта жіберу үшін POST /v1/verify маршрутын қайта шақырыңыз. Бұл жаңа id мен жаңа коды бар жаңа сессия, сондықтан:

жеткізілген кезде оның ақысы бөлек алынады;
ол нөмірге арналған сессия лимитіне есептеледі, лимиттен асса, 429 rate_limited қайтарылады;
күшін жою баптауы қосылмаса, бұрынғы код мерзімі біткенге дейін жарамды болып қала береді.