{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"428060fb-d818-4536-9a76-9c73bc105546","name":"Kod.mobi integration API","description":"[<b>kod.mobi</b>](https://kod.mobi/) allows any project to implement an authorization system using **one-time verification codes** delivered via **messengers, SMS, or email**\n\n## API endpoints\n\n- [<b>https://api.kod.mobi</b>](https://api.kod.mobi)\n    \n\n## Authentication\n\nThe API is accessed using a **pair of API keys**, which can be obtained in your [personal account](https://user.kod.mobi/settings/api-key).\n\n### API keys\n\n- **Public Key** — used in all API requests\n    \n- **Secret Key** — **server-side only**, used for sensitive operations\n    \n\n### API Key Usage\n\nAll API requests must include your **Public Key** in the request headers:\n\n```\nx-api-key: your-public-api-key\n\n ```\n\n### Secret Key\n\nThe **Secret Key** must be used for **server-side API requests only** and must never be exposed to the client.\n\n---\n\n## Localization\n\nWe support the following languages:\n\n- `en` (default)\n    \n- `ru`\n    \n\nTo change the language, include the `Accept-Language` header in your request:\n\n```\nAccept-Language: ru\n\n ```\n\n---\n\n## CAPTCHA (Challenge)\n\n**CAPTCHA (Challenge)** is a CAPTCHA-based protection mechanism used to secure form requests from automated abuse and bot traffic.\n\nAt the moment, the following providers are supported:\n\n- [<b>Turnstile</b>](https://www.cloudflare.com/ru-ru/application-services/products/turnstile) (CloudFlare)\n    \n- [<b>SmartCaptcha</b>](https://yandex.cloud/ru/services/smartcaptcha) (Yandex)\n    \n- [<b>reCAPTCHA</b>](https://developers.google.com/recaptcha) (Google)\n    \n\nIf **challenge** is enabled in the project settings, the project settings response will include an **`api_key`**.\n\nThis key must be used for **client-side initialization** of the CAPTCHA provider.\n\nEach form request **protected by challenge** must include a valid CAPTCHA token.\n\n### Protected Requests\n\nThe following requests are protected by CAPTCHA:\n\n- /create (**action**: create)\n    \n\n### Token Generation and Validation\n\n- When generating a CAPTCHA token for a specific request, you **must specify its** **`action`** (if supported by the provider).\n    \n- If the token is valid but the **action is invalid**, the request will be **rejected**.\n    \n- After generating the token, include it in the request headers:\n    \n\n```\nx-challenge-token: <captcha-token>\n\n ```\n\n> For **Turnstile**, the legacy `x-cf-turnstile-token` header is also supported. \n  \n\n---\n\n## Integration Flows\n\nkod.mobi supports two integration modes:\n\n|  | **Session Flow** | **Manual Flow** |\n| --- | --- | --- |\n| **Description** | A **fully managed** verification flow where **kod.mobi handles code delivery and validation** within a **single 3-minute session**.  <br>  <br>Users can choose the delivery channel (**SMS, messenger, email**), and **minimal client-side logic** is required. | A **backend-driven** integration where **your system controls code generation, validation, and provider selection**.  <br>  <br>kod.mobi is used **only for message delivery** via the API, with **no session constraints**. |\n| **Best suited for** | **Fast and simple integrations** with **minimal backend logic**. | **Custom verification flows** and **full control over OTP logic**. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"27979643","team":1254969,"collectionId":"428060fb-d818-4536-9a76-9c73bc105546","publishedId":"2sBXc7Jiqd","public":true,"publicUrl":"https://documenter-api.postman.tech/view/27979643/2sBXc7Jiqd","privateUrl":"https://go.postman.co/documentation/27979643-428060fb-d818-4536-9a76-9c73bc105546","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2026-02-02T10:28:47.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"api.kod.mobi (public)","id":"dee01d05-02b7-4726-8c05-2aad52f114c0","owner":"7795553","values":[{"key":"baseUrl","value":"https://api.kod.mobi","enabled":true,"type":"default"},{"key":"v1_prefix","value":"api/v1","enabled":true,"type":"default"},{"key":"v2_prefix","value":"v2","enabled":true,"type":"default"},{"key":"apiKey","value":"","enabled":true,"type":"default"},{"key":"secret","value":"","enabled":true,"type":"default"},{"key":"session_id","value":"","enabled":true,"type":"default"},{"key":"verify_token","value":"","enabled":true,"type":"default"},{"key":"lang","value":"en","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/bc4c6b2b2e64afa33af5b1ad463ab92003e39da28e0988dbeeb9f301500995bf","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"api.kod.mobi (public)","value":"7795553-dee01d05-02b7-4726-8c05-2aad52f114c0"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBXc7Jiqd"}